Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.65 KB
Raw

Git branches and commits patterns

branch name format

[type]/[GITHUB-TASK]-[short-description]

feature/#256-some-feature
bugfix/#0-some-issue

commit message format

[GITHUB-TASK] [Module] - [work description]

#256/Inject - added some logic
#0/Popup - changed some thing

PR title format (used in app change log)

[type]/[GITHUB-TASK] [app change description]

#256 added some logic
#0 changed some thing

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.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've changed APIs, update the documentation.
  3. Issue that pull request!

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under its GPL-2.0 License