Update CONTRIBUTING.md

This commit is contained in:
Eli Bendersky 2022-12-12 05:48:06 -08:00 committed by GitHub
parent bc9700aab3
commit 7b502fa0ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,10 +3,12 @@
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.
`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