From cf919770daed34363705e68cdf477cf8c4b995ac Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Tue, 23 Mar 2021 11:58:14 +0100 Subject: [PATCH] Update contribution guidelines ...to include changes to `syntax.md` if relevant. --- docs/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b11c069..a0b3a0e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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. Push the changes to your fork. 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. ### Hints