Skip to content

Commit 6af9f1e

Browse files
committed
docs(contributing): add CONTRIBUTING.rst
Signed-off-by: Patrick Avery <patrick.avery@kitware.com>
1 parent e0a78fb commit 6af9f1e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
================================
2+
Contributing to trame-matplotlib
3+
================================
4+
5+
#. Clone the repository using ``git clone``
6+
#. Install pre-commit via ``pip install pre-commit``
7+
#. Run ``pre-commit install`` to set up pre-commit hooks
8+
#. Make changes to the code, and commit your changes to a separate branch
9+
#. Create a fork of the repository on GitHub
10+
#. Push your branch to your fork, and open a pull request
11+
12+
Tips
13+
####
14+
15+
#. 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.
16+
#. 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.
17+
#. Sometimes, ``black`` and ``flake8`` do not agree. Add options to your ``.flake8`` file to fix these things. See the `flake8 configuration docs <https://flake8.pycqa.org/en/latest/user/configuration.html>`_ for more details.
18+
#. 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.
19+
#. The `.codespellrc file <https://github.com/codespell-project/codespell#using-a-config-file>`_ can be used fix any other codespell issues, such as ignoring certain files, directories, words, or regular expressions.

0 commit comments

Comments
 (0)