actions/setup-java
1
0
Fork 0
mirror of https://github.com/actions/setup-java synced 2024-11-05 05:05:44 +00:00
Code Issues Projects Releases Packages Wiki Activity
setup-java/docs/adrs/README.md
Konrad Pabjan fc62ccaa4f
V2 setup-java ADR (#97) 
* V2 setup-java initial ADR

* Update ADR

* Misc fixes

* Clarifications around default behavior and new input

* PR feedback
2021-03-08 12:38:33 -05:00

860 B
Raw Blame History

ADRs

ADR, short for "Architecture Decision Record" is a way of capturing important architectural decisions, along with their context and consequences.

This folder includes ADRs for the setup-java action. ADRs are proposed in the form of a pull request, and they commonly follow this format:

  • Title: short present tense imperative phrase, less than 50 characters, like a git commit message.

  • Status: proposed, accepted, rejected, deprecated, superseded, etc.

  • Context: what is the issue that we're seeing that is motivating this decision or change.

  • Decision: what is the change that we're actually proposing or doing.

  • Consequences: what becomes easier or more difficult to do because of this change.

  • More information about ADRs can be found here.