gobyexample/CONTRIBUTING.md
2019-07-12 06:14:47 -07:00

19 lines
804 B
Markdown

## Contributing
Thanks for your interest in contributing to Go by Example!
* When sending a PR that affects the displayed contents of the site, run
`tools/build` locally and include the generated HTML in the PR. If you
only want to submit a simple typo suggestion (for example, through the
Github website), feel free to send a PR anyway - we'll regenerate the
HTML and merge with your commit.
* We're open to adding more examples to the site. They should be on things
used by many programmers and only require the standard library. If you're
interested in adding an example, _please open an issue to discuss the topic
first_.
* 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
text.