Thank you for your interest in contributing to the VSCode GCode Syntax project. Please note the Code of Conduct document and follow it in all of your interactions with this project.
There are a variety of ways you can contribute to this project.
- Help answer issues or questions on using the extension
- Find Bugs and Fix them!
- Work on new features!
- Fix Typos! (I make a lot of them)
- Edit Documentation
Here are a couple guidelines to get you started...
To contribute to VSCode GCode Syntax, you need to fork this repository and submit a pull request for any changes.
Search open/closed issues before submitting any code changes because someone may have pushed the same code before.
Please create an issue before creating your pull request.
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.
This project contains an .editorconfig file. If your IDE or code editor doesn't natively support it, please install the EditorConfig plugin.
This project uses prettier for code formatting. You can run prettier across the code by calling npm run pretty from a terminal.
To format the code as you make changes you can install the Prettier - Code formatter extension.
Add the following to your User Settings to run prettier:
"editor.formatOnSave": true,
This project uses ESLint 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.
To lint the code as you make changes you can install the ESLint extension.
If this is your first contribution to GCode Reference, please give yourself credit by adding yourself to the Contributors section of the README in the following format:
Your Name ([@<your-github-username>(https://github.com/<your-github-username)]) - [contributions](https://github.com/appliedengdesign/vscode-gcode-syntax/commits?author=<your-github-username>
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.
Check out this article: How (and why) to sign Git commits
Visual Studio Code is a preferred tool to work on this project.
Please follow all instructions in the PR template.
- Push your changes to your branch in your fork of the repository.
- Submit a pull request to the master of the vscode-gcode-syntax respository.
- Make sure to explicitly say not to complete pull request if you are still making changes.