Update contribution guidelines

...to include changes to `syntax.md` if relevant.
This commit is contained in:
Daniel Rojas 2021-03-23 11:58:14 +01:00
parent cbc30b7323
commit cf919770da

View File

@ -26,6 +26,7 @@ When contributing to this repository, please [submit a new issue](https://github
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. 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.
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.
### Hints ### Hints