Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
setup-java/docs/adrs/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
19 lines (10 sloc)
860 Bytes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# 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](https://github.com/joelparkerhenderson/architecture_decision_record). |