From 90471966aa15c69c90c1be0a0c1e7df8d2c053e7 Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Fri, 9 Feb 2018 09:31:11 -0800 Subject: [PATCH] Expand on contributing documentation. Add sections on PR expectations, and explicitly link to contributing guideline. --- CONTRIBUTING.md | 20 ++++++++++++++------ README.md | 5 +++++ 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8655fbebe2..81754c586e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,9 +19,17 @@ again. Participation in this project comes under the [Contributor Covenant Code of Conduct](code-of-conduct.md) -## Code reviews - -All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. +## Submitting code via Pull Requests + +- We follow the [Github Pull Request Model](https://help.github.com/articles/about-pull-requests/) for + all contributions. +- For large bodies of work, we recommend creating an issue and labelling it + "[kind/design](https://github.com/googleprivate/agones/issues?q=is%3Aissue+is%3Aopen+label%3Akind%2Fdesign)" + outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance + for review to happen early, and ensures no wasted effort occurs. +- All submissions, including submissions by project members, will require review before being merged. +- Once review has occurred, please rebase your PR down to a single commit. This will ensure a nice clean Git history. +- Finally - *Thanks* for considering submitting code to Agones! + +### Additional Resources +- [How to write a good Git Commit message](How to Write a Git Commit Message) \ No newline at end of file diff --git a/README.md b/README.md index 33b597ac18..3c824c33a4 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,13 @@ More documentation forthcoming. - Mailing List (forthcoming) ## Development and Contribution + +Please read the [contributing](CONTRIBUTING.md) guide for directions on submitting Pull Requests to Agones. + See the tools in the [build](build/README.md) directory for testing and building Agones from source. +Agones is in active development - we would love your help in shaping its future! + ## Licence Apache 2.0 \ No newline at end of file