yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gobyexample/CONTRIBUTING.md
Eli Bendersky 7b502fa0ec
Update CONTRIBUTING.md
2022-12-12 05:48:06 -08:00

911 B
Raw Blame History

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. Note that updating the HTML in the public directory by itself is insufficient, since the source of truth for the website is in the examples directory.

    If you don't want to deal with getting a proper PR in, feel free to just open an issue an point out the change you suggest.

  • 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 one on the title text.