From 7b502fa0ec75f0936ce6c5426b6c15e1b91d020b Mon Sep 17 00:00:00 2001 From: Eli Bendersky Date: Mon, 12 Dec 2022 05:48:06 -0800 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a13548..051c6d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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