yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update contributing guide

Browse Source
This commit is contained in:
Mark McGranaghan 2019-05-30 12:57:13 -07:00
parent 21bba9d169
commit 75abd7facb
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -1,18 +1,16 @@
## Contributing ## Contributing
Go by Example is now in a steady state. We are maintaining it, but are not Thanks for your interest in contributing to Go by Example!
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 * 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 .go or .sh source file should be sufficient for the PR. I can rebuild the
HTML when I review the change. HTML when I review the change.
* We are not going to add any more sections to the site. There are many * We're open to adding more examples to the site. They should be on things
important topics that Go by Example doesn't cover, which we leave to other used by many programmers and only require the standard library. If you're
resources. interested in adding an example, _please open an issue to discuss the topic
first_.
* We are not going to change the navigation of the site, in particular adding * We're 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 a "previous section" link or an "index" link other than the on the title
text. text.