Thank you for your interest in contributing to this g-code reference package. Here are a couple guidelines to get you started...
To contribute to CNC Codes JSON Schema, you need to fork this repository and submit a pull request for the JSON that you want to add to or change.
The content in this repository is as follows:
/docs- Location of Github Pages for schema/scripts- Location of helper scripts/src- Main Source Files of npm package/src/schema/- Location of JSON Schema file
/test- Mocha test to validate schema/test/sample- sample files to test validation
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 the github pages in /docs.
Visual Studio Code is a preferred tool to work on this project.
npm run test- Runs a Mocha test against the JSON Schemanpm run build-ghp- Builds the GitHub Pages with the current working schema and README
- Push your changes to the branch in your fork of the repository.
- Validate your changes using the script
npm run testand look for any breaking issues. - Submit a pull request to the development branch of the cnccodes-json-schema respository.
- Make sure to explicitly say not to complete pull request if you are still making changes.