Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

36 lines (30 loc) · 1.61 KB
Raw

Contributing to Transcriptase

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 Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

Git workflow

CPG uses this Git Feature Branch Workflow workflow to ensure we have a standard, click here to read more. But a quick summarization:

  1. Fetch.
  2. Be in develop branch
  3. Pull.
  4. Create a issue/feature of what you want to change
  5. Fork (If you are not a member of Tolfix)
  6. Create a branch with format of feature/ISSUE_ID-NAME-OF-CHOICE (ISSUE_ID is the id of the issue you created on 4)
  7. Code
  8. Commit each change and pull/merge from develop
  9. Once done create a PR
  10. Once merged repeat for new features/ideas.

Any contributions you make will be under the MIT Software License

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.

Styling

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.

License

By contributing, you agree that your contributions will be licensed under its MIT License.