From c4da77b23a9f3d7184a24c5b4e503e918d6e779d Mon Sep 17 00:00:00 2001 From: jonwzheng Date: Thu, 8 Aug 2024 12:44:58 -0400 Subject: [PATCH] clarify CONTRIBUTING that .rst changes should go to main branch --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9def443cca..83f07e7ee3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli * The live version of the documentation is hosted on the `gh-pages` branch which is updated upon pushes to the `main` branch of RMG-Py. -* To add new documentation, create or modify `.rst` (reStructuredText) files under the `documentation` directory. For a primer on how to write `.rst` markup, please [check out the Sphinx documentation.](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) +* To add new documentation, create or modify `.rst` (reStructuredText) files under the `documentation` directory and create a PR to push to `main`. For a primer on how to write `.rst` markup, please [check out the Sphinx documentation.](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) * Please test the documentation on a local build (e.g., via `make html` in the `documentation` directory) before pushing changes.