diff options
| author | Jarrod Millman <jarrod.millman@gmail.com> | 2020-07-09 23:25:00 -0700 |
|---|---|---|
| committer | Jarrod Millman <jarrod.millman@gmail.com> | 2020-07-10 09:45:35 -0700 |
| commit | 8e7892ef546b07c9b1ed0298f8f2aceb1436e50d (patch) | |
| tree | edc0f4ee5b0e488068eaecb2f12518008ae00347 /CONTRIBUTING.rst | |
| parent | b22d6b36ce0545995c99d233546e8a1fe7e27fc5 (diff) | |
| download | networkx-8e7892ef546b07c9b1ed0298f8f2aceb1436e50d.tar.gz | |
Add pre-commit hook to for psf/black
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b8c3edc1..292fd113 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -48,7 +48,11 @@ Contributor Guide system. To ensure you have a properly-configured development environment for running the tests, see `Build environment setup`_. -4. To submit your contribution: +4. Format your code: + + * We use psf/black to format Python code. + +5. To submit your contribution: * Push your changes back to your fork on GitHub:: @@ -65,7 +69,7 @@ For a more detailed discussion, read these :doc:`detailed documents <gitwash/index>` on how to use Git with ``networkx`` (`<https://networkx.github.io/documentation/latest/developer/gitwash/index.html>`_). -5. Review process: +6. Review process: * Reviewers (the other developers and interested community members) will write inline and/or general comments on your Pull Request (PR) to help @@ -95,7 +99,7 @@ For a more detailed discussion, read these :doc:`detailed documents If closing a bug, also add "Fixes #1480" where 1480 is the issue number. -6. Document changes +7. Document changes If your change introduces any API modifications, please update ``doc/release/release_dev.rst``. |