forked from actions/toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Contributing.md and add information about ADR's (actions#383)
* Updating Contributing.md + add adr details
- Loading branch information
Showing
3 changed files
with
41 additions
and
3 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# 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 actions toolkit. 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). |