Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (30 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.42 KB

Contribute to G-Code Reference

Thank you for your interest in contributing to this g-code reference package. Here are a couple guidelines to get you started...

Getting Started

To contribute to G-Code Reference, you need to fork this repository and submit a pull request for the JSON that you want to add to or change.

Repository Organization

The content in this repository is as follows:

  • /src - Main Source Files of npm package
    • /src/json/ - Location of JSON files
      • /src/json/schema - Location of schema file. ( cnccodes-json-schema )
      • /src/json/lathe/ - Lathe JSON Files ( Separated into gcodes.json and mcodes.json )
      • /src/json/mill - Mill JSON Files
      • /src/json/printer - 3D Printer JSON Files
    • /src/test/ - Typescript files for testing package
  • /scripts - Utility scripts for validation, workflow, etc.

Branches

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 create a branch to work on a specifc machine's gcodes.json or mcodes.json.

Authoring Tools

Visual Studio Code is a preferred tool to work on this project.

Submitting Changes

  • Push your changes to the branch in your fork of the repository.
  • Submit a pull request to the development branch of the gcode-reference respository.
  • Make sure to explicitly say not to complete pull request if you are still making changes.

Additional Resources