Skip to content

Commit 22f7d8a

Browse files
committed
Added info about signing commits
1 parent 74eba59 commit 22f7d8a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ To contribute to [VSCode GCode Syntax](https://github.com/appliedengdesign/vscod
2121
- [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/)
2222
- [How to squash commits](https://help.github.com/articles/about-pull-request-merges/)
2323

24+
Search open/closed issues before submitting any code changes because someone may have pushed the same code before.
25+
26+
Please create an issue _before_ creating your pull request.
27+
2428
### Branches
2529

2630
Create a local working branch that is specific to the scope of the changes that you want to make and then submit a pull request when your changes are ready. Each branch you create should be as specific as possible to streamline work flow and to reduce the possibility of merge conflicts. For instance, consider creating a branch to work on documentation or to fix a typo.
@@ -49,6 +53,12 @@ If this is your first contribution to GCode Reference, please give yourself cred
4953

5054
- `Your Name ([@<your-github-username>(https://github.com/<your-github-username)]) - [contributions](https://github.com/appliedengdesign/vscode-gcode-syntax/commits?author=<your-github-username>`
5155

56+
### Signing Your Commits
57+
58+
This project requires that commits are GPG signed. This ensures that YOU are really the author of your commit, and the code is REALLY what you wrote.
59+
60+
Check out this article: [How (and why) to sign Git commits](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)
61+
5262
### Authoring Tools
5363

5464
[Visual Studio Code](https://code.visualstudio.com) is a preferred tool to work on this project.

0 commit comments

Comments
 (0)