-
-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(contributing): add CONTRIBUTING.rst
Signed-off-by: Patrick Avery <patrick.avery@kitware.com>
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://flake8.pycqa.org/en/latest/user/configuration.html>`_ 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 <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. |