From 9e5127537c23b743b04cbafff3f5f21ba277344a Mon Sep 17 00:00:00 2001 From: Patrick Avery Date: Mon, 6 Jun 2022 12:24:32 -0500 Subject: [PATCH] docs(contributing): add CONTRIBUTING.rst Signed-off-by: Patrick Avery --- CONTRIBUTING.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..083b4161 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +===================== +Contributing to trame +===================== + +#. Clone the repository using ``git clone`` +#. Install pre-commit via ``pip install pre-commit`` +#. Run ``pre-commit install`` to set up pre-commit hooks +#. Make changes to the code, and commit your changes to a separate branch +#. Create a fork of the repository on GitHub +#. Push your branch to your fork, and open a pull request + +Tips +#### + +#. When first creating a new project, it is helpful to run ``pre-commit run --all-files`` to ensure all files pass the pre-commit checks. +#. A quick way to fix ``black`` issues is by installing black (``pip install black``) and running the ``black`` command at the root of your repository. +#. Sometimes, ``black`` and ``flake8`` do not agree. Add options to your ``.flake8`` file to fix these things. See the `flake8 configuration docs `_ for more details. +#. A quick way to fix ``codespell`` issues is by installing codespell (``pip install codespell``) and running the ``codespell -w`` command at the root of your directory. +#. The `.codespellrc file `_ can be used fix any other codespell issues, such as ignoring certain files, directories, words, or regular expressions.