From 86b0df98959bf984a9026084431a30eef8692d36 Mon Sep 17 00:00:00 2001 From: Mark McGranaghan Date: Tue, 27 Dec 2016 08:47:09 -0800 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0d70228 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Contributing + +Go by Example is now in a steady state. We are maintaining it, but are not +expanding or significantly changing it any more. + +With that in mind here are some specific contribution guidelines: + +* If you see a typo or would like to suggest another small change, editing the + .go or .sh source file should be sufficient for the PR. I can rebuild the + HTML when I review the change. + +* We are not going to add any more sections to the site. There are many + important topics that Go by Example doesn't cover, which we leave to other + resources. + +* We are not going to change the navigation of the site, in particular adding + a "previous section" link or an "index" link other than the on the title + text.