From a1cf1b49006ee180bb8863c56e59b460780fc177 Mon Sep 17 00:00:00 2001 From: Matthew Avaylon Date: Thu, 14 Mar 2024 09:50:42 -0700 Subject: [PATCH] Update CONTRIBUTING.rst --- docs/CONTRIBUTING.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index d51aa12e9..2ee5d48cb 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -119,7 +119,7 @@ Style Guides ------------ Git Commit Message Style Guide -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Use the present tense ("Add feature" not "Added feature") * The first line should be short and descriptive. @@ -128,7 +128,7 @@ Git Commit Message Style Guide * Reference relevant issues and pull requests liberally after the first line. Documentation Style Guide -^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^ All documentations is written in reStructuredText (RST) using Sphinx. @@ -138,12 +138,12 @@ Did you fix whitespace, format code, or make a purely cosmetic patch in source c Source code changes that are purely cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted unless they have been approved beforehand. One of the main reasons is that there are a lot of hidden costs in addition to writing the code itself, and with the limited resources of the project, we need to optimize developer time. E.g,. someone needs to test and review PRs, backporting of bug fixes gets harder, it creates noise and pollutes the git repo and many other cost factors. Format Specification Style Guide -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **Coming soon** Python Code Style Guide -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^ Before you create a Pull Request, make sure you are following the PyNWB style guide. To check whether your code conforms to the PyNWB style guide, simply run the ruff_ tool in the project's root