actions/toolkit
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/actions/toolkit synced 2026-04-18 02:48:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Contributing.md and add information about ADR's (#383)

Browse Source 
* Updating Contributing.md + add adr details
This commit is contained in:
Thomas Boop
2020-03-17 11:57:32 -04:00
committed by GitHub
parent 17b97eceec
commit 12f30111a0
3 changed files with 41 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/adrs/README.md Normal file
View File

@@ -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).