From 8e7892ef546b07c9b1ed0298f8f2aceb1436e50d Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Thu, 9 Jul 2020 23:25:00 -0700 Subject: Add pre-commit hook to for psf/black --- CONTRIBUTING.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.rst') 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 ` on how to use Git with ``networkx`` (``_). -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``. -- cgit v1.2.1