From 12f30111a040dc2d1238a14516f5297d12e3175b Mon Sep 17 00:00:00 2001
From: Thomas Boop <52323235+thboop@users.noreply.github.com>
Date: Tue, 17 Mar 2020 11:57:32 -0400
Subject: [PATCH] Update Contributing.md and add information about ADR's (#383)

* Updating Contributing.md + add adr details
---
 docs/contribute.md => .github/CONTRIBUTING.md | 23 +++++++++++++++++--
 README.md                                     |  2 +-
 docs/adrs/README.md                           | 19 +++++++++++++++
 3 files changed, 41 insertions(+), 3 deletions(-)
 rename docs/contribute.md => .github/CONTRIBUTING.md (59%)
 create mode 100644 docs/adrs/README.md

diff --git a/docs/contribute.md b/.github/CONTRIBUTING.md
similarity index 59%
rename from docs/contribute.md
rename to .github/CONTRIBUTING.md
index a27741c1..d89e2032 100644
--- a/docs/contribute.md
+++ b/.github/CONTRIBUTING.md
@@ -1,4 +1,23 @@
-## Development
+# Contributions
+
+We welcome contributions in the form of issues and pull requests.  We view the contributions and process as the same for internal and external contributors.
+
+## Issues
+
+Log issues for both bugs and enhancement requests.  Logging issues are important for the open community.
+
+Issues in this repository should be for the toolkit packages.  Runner specific issues can be filed [in the runner repository](https://github.com/actions/runner).
+
+## Enhancements and Feature Requests
+
+We ask that before significant effort is put into code changes, that we have agreement on taking the change before time is invested in code changes. 
+
+1. Create a feature request. 
+2. When we agree to take the enhancement, create an ADR to agree on the details of the change.
+
+An ADR is an Architectural Decision Record.  This allows consensus on the direction forward and also serves as a record of the change and motivation. [Read more here](../docs/adrs/README.md).
+
+## Development Life Cycle
 
 This repository uses [Lerna](https://github.com/lerna/lerna#readme) to manage multiple packages. Read the documentation there to begin contributing.
 
@@ -37,4 +56,4 @@ This will ask you some questions about the new package. Start with `0.0.0` as th
 }
 ```
 
-3. Start developing 😄 and open a pull request.
+3. Start developing 😄.
diff --git a/README.md b/README.md
index 17161c86..948dd985 100644
--- a/README.md
+++ b/README.md
@@ -199,7 +199,7 @@ console.log(`We can even get context data, like the repo: ${context.repo.repo}`)
 
 ## Contributing
 
-We welcome contributions.  See [how to contribute](docs/contribute.md).
+We welcome contributions.  See [how to contribute](.github/CONTRIBUTING.md).
 
 ## Code of Conduct
 
diff --git a/docs/adrs/README.md b/docs/adrs/README.md
new file mode 100644
index 00000000..6851a5ec
--- /dev/null
+++ b/docs/adrs/README.md
@@ -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).
\ No newline at end of file