From f783c4169886b5cc40ee62e35a9fa378b907592f Mon Sep 17 00:00:00 2001 From: Eli Bendersky Date: Mon, 12 Dec 2022 05:49:47 -0800 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 051c6d6..770268b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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