Skip to content

Commit

Permalink
[contributing] Add contribution setup and pre-commit steps
Browse files Browse the repository at this point in the history
  • Loading branch information
sgaist committed Mar 2, 2020
1 parent 7f4db3b commit f40e991
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ add their details to the [Code Contributors](#code-contributors) section of
this file as part of their first Pull Request, and reviewers are responsible
for checking this before merging the new branch into *master*.

In order to start modifying cylc-flow and test these changes, the first step is
to call `pip install -e .[all]`. This will install the package in development
mode along all needed dependencies.

Before the first commit care should be taken to call `pre-commit install` in
order for the git pre-commit hooks to be run on commit. [pre-commit
](https://pre-commit.com) is used for code style consistency. It can also be run
manually when developing with the `pre-commit run` command. To run the hooks on
a reduced set of files, cal `pre-commit run --files` followed by one of more
files to process.

## Code Contributors

The following people have contributed to this code under the terms of
Expand Down

0 comments on commit f40e991

Please sign in to comment.