We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use github to host code, to track issues and feature requests, as well as accept pull requests.
CPG uses this Git Feature Branch Workflow
workflow to ensure we have a standard, click here to read more.
But a quick summarization:
- Fetch.
- Be in
develop
branch - Pull.
- Create a issue/feature of what you want to change
- Fork (If you are not a member of
Tolfix
) - Create a branch with format of
feature/ISSUE_ID-NAME-OF-CHOICE
(ISSUE_ID is the id of the issue you created on4
) - Code
- Commit each change and pull/merge from develop
- Once done create a
PR
- Once merged repeat for new features/ideas.
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
CPG uses strict styling, and to make it easier you can use vscode and ensure that eslint styles.
We use allman
braces which is the most strict rules.
But always be sure to enable eslint
.
By contributing, you agree that your contributions will be licensed under its MIT License.