Update CONTRIBUTING.md

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

View File

@ -2,13 +2,16 @@
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
* When sending a PR that affects the displayed contents of the site,
updating the HTML in the `public` directory by itself is insufficient, since
the source of truth for the website is in the `examples` directory.
Instead, update the proper source file(s) in the `examples` directory and
run `tools/build` locally to regenerate the HTML; include both changes in
your PR.
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.
open an issue and 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