Mention isort and black in contribution guidelines

This commit is contained in:
Daniel Rojas 2021-10-15 18:14:03 +02:00 committed by Laurier Loiselle
parent a255596471
commit daff23cbaa
No known key found for this signature in database
GPG Key ID: 345920CC72089A3F

View File

@ -25,6 +25,7 @@ When contributing to this repository, please [submit a new issue](https://github
1. Create a new feature branch on top of the `dev` branch. 1. Create a new feature branch on top of the `dev` branch.
1. Commit your code changes to this feature branch. 1. Commit your code changes to this feature branch.
1. Push the changes to your fork. 1. Push the changes to your fork.
1. Please format your code using [`isort`](https://pycqa.github.io/isort/) and [`black`](https://black.readthedocs.io) before submitting.
1. Submit a new pull request, using `dev` as the base branch. 1. Submit a new pull request, using `dev` as the base branch.
- If your code changes or extends the WireViz YAML syntax, be sure to update the [syntax description document](https://github.com/formatc1702/WireViz/blob/dev/docs/syntax.md) in your PR. - If your code changes or extends the WireViz YAML syntax, be sure to update the [syntax description document](https://github.com/formatc1702/WireViz/blob/dev/docs/syntax.md) in your PR.
1. Please include in the PR description (and optionally also in the commit message body) a reference (# followed by issue number) to the issue where the suggested changes are discussed. 1. Please include in the PR description (and optionally also in the commit message body) a reference (# followed by issue number) to the issue where the suggested changes are discussed.