Skip to content

Commit 6596426

Browse files
committed
Updated Contributing doc
1 parent 2bab8d4 commit 6596426

File tree

1 file changed

+62
-15
lines changed

1 file changed

+62
-15
lines changed

CONTRIBUTING.md

Lines changed: 62 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,74 @@
1-
# How to contribute
1+
# Contribute to VSCode GCode Syntax
22

3-
If you would like to contribute to the vscode-gcode-syntax project, here are a couple guidelines.
3+
Thank you for your interest in contributing to the VSCode GCode Syntax project. Please note the [Code of Conduct](CODE_OF_CONDUCT.md) document and follow it in all of your interactions with this project.
4+
5+
There are a variety of ways you can contribute to this project.
6+
7+
- Help answer issues or questions on using the extension
8+
- Find Bugs and Fix them!
9+
- Work on new features!
10+
- Fix Typos! (I make a lot of them)
11+
- Edit Documentation
12+
13+
Here are a couple guidelines to get you started...
414

515
## Getting Started
616

7-
* Fork the repository on GitHub
8-
* Create a feature branch based on the development branch
17+
To contribute to [VSCode GCode Syntax](https://github.com/appliedengdesign/vscode-gcode-syntax), you need to fork this repository and submit a pull request for any changes.
18+
19+
- [How to fork a repository](https://help.github.com/articles/fork-a-repo)
20+
- [How to make a pull request](https://help.github.com/articles/creating-a-pull-request/)
21+
- [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/)
22+
- [How to squash commits](https://help.github.com/articles/about-pull-request-merges/)
23+
24+
### Branches
25+
26+
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.
27+
28+
### Formatting
29+
30+
This project contains an [`.editorconfig`](https://github.com/appliedengdesign/vscode-gcode-syntax/blob/main/.editorconfig) file. If your IDE or code editor doesn't natively support it, please install the [EditorConfig](https://editorconfig.org) plugin.
31+
32+
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `npm run pretty` from a terminal.
33+
34+
To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.
35+
36+
Add the following to your User Settings to run prettier:
37+
38+
`"editor.formatOnSave": true,`
39+
40+
### Linting
41+
42+
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `npm run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.
43+
44+
To lint the code as you make changes you can install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
45+
46+
### Update the README
47+
48+
If this is your first contribution to GCode Reference, please give yourself credit by adding yourself to the _Contributors_ section of the [README](README.md) in the following format:
49+
50+
- `Your Name ([@<your-github-username>(https://github.com/<your-github-username)]) - [contributions](https://github.com/appliedengdesign/vscode-gcode-syntax/commits?author=<your-github-username>`
51+
52+
### Authoring Tools
53+
54+
[Visual Studio Code](https://code.visualstudio.com) is a preferred tool to work on this project.
55+
56+
#### Recommended Extensions
957

10-
## Making Changes
58+
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
59+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
1160

12-
* Make changes in your separate branch
13-
* Make sure commit messages are easy to understand
14-
* Make sure to test your extension as much as possible
61+
### Submitting a Pull Request
1562

16-
## Submitting Changes
63+
Please follow all instructions in the [PR template](.github/PULL_REQUEST_TEMPLATE.md).
1764

18-
* Push your changes to the branch in your fork of the repository.
19-
* Submit a pull request to the [development branch](https://github.com/appliedengdesign/vscode-gcode-syntax/tree/dev) of the [vscode-gcode-syntax](https://github.com/appliedengdesign/vscode-gcode-syntax) respository.
20-
* Make sure to explicitly say not to complete pull request if you are still making changes.
65+
- Push your changes to your branch in your fork of the repository.
66+
- Submit a pull request to the [master](https://github.com/appliedengdesign/master-syntax/tree/master) of the [vscode-gcode-syntax](https://github.com/appliedengdesign/vscode-gcode-syntax) respository.
67+
- Make sure to explicitly say not to complete pull request if you are still making changes.
2168

2269
## Additional Resources
2370

24-
* [GitHub Docs](http://help.github.com/)
25-
* [GitHub Pull Request Docs](http://help.github.com/send-pull-requests/)
26-
* [Successful Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
71+
- [GitHub Docs](http://help.github.com/)
72+
- [GitHub Pull Request Docs](http://help.github.com/send-pull-requests/)
73+
- [Successful Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
2774

0 commit comments

Comments
 (0)