From 226ea5816cc7454b79e9552d4e9193b2394fe0e6 Mon Sep 17 00:00:00 2001 From: Serene-Arc <33189705+Serene-Arc@users.noreply.github.com> Date: Sun, 24 Sep 2023 13:53:01 +1000 Subject: [PATCH] Add pre-commit to docs for devs --- CONTRIBUTING.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a4ee45e6a..4e2df8cf9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -137,19 +137,21 @@ request and your code will ship in no time. 1. Fork the beets repository and clone it (see above) to create a workspace. -2. Make your changes. -3. Add tests. If you’ve fixed a bug, write a test to ensure that you’ve +2. Install pre-commit, following the instructions `here + `_. +3. Make your changes. +4. Add tests. If you’ve fixed a bug, write a test to ensure that you’ve actually fixed it. If there’s a new feature or plugin, please contribute tests that show that your code does what it says. -4. Add documentation. If you’ve added a new command flag, for example, +5. Add documentation. If you’ve added a new command flag, for example, find the appropriate page under ``docs/`` where it needs to be listed. -5. Add a changelog entry to ``docs/changelog.rst`` near the top of the +6. Add a changelog entry to ``docs/changelog.rst`` near the top of the document. -6. Run the tests and style checker. The easiest way to run the tests is +7. Run the tests and style checker. The easiest way to run the tests is to use `tox`_. For more information on running tests, see :ref:`testing`. -7. Push to your fork and open a pull request! We’ll be in touch shortly. -8. If you add commits to a pull request, please add a comment or +8. Push to your fork and open a pull request! We’ll be in touch shortly. +9. If you add commits to a pull request, please add a comment or re-request a review after you push them since GitHub doesn’t automatically notify us when commits are added.