55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# Contribution guidelines
|
|
|
|
Contributing to this project should be 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
|
|
|
|
## Github are used for everything
|
|
|
|
Github is used to host code, to track issues and feature requests, as well as accept pull requests.
|
|
|
|
Pull requests are the best way to propose changes to the codebase.
|
|
|
|
1. Fork the repo and create your branch from `master`.
|
|
2. If you've changed something, update the documentation.
|
|
3. Make sure your code lints (using black).
|
|
4. Issue that pull request!
|
|
|
|
## 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](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
|
|
|
|
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
|
|
|
|
GitHub issues are used to track public bugs.
|
|
Report a bug by [opening a new issue](../issues); it's that easy!
|
|
|
|
## Write bug reports with detail, background, and sample code
|
|
|
|
**Great Bug Reports** tend to have:
|
|
|
|
- A quick summary and/or background
|
|
- Steps to reproduce
|
|
- Be specific!
|
|
- Give sample code if you can.
|
|
- What you expected would happen
|
|
- What actually happens
|
|
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
|
|
|
People *love* thorough bug reports. I'm not even kidding.
|
|
|
|
## Use a Consistent Coding Style
|
|
|
|
Use [black](https://github.com/ambv/black) to make sure the code follow the style.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under its MIT License.
|
|
|
|
## References
|
|
|
|
This document was adapted from the open-source contribution guidelines
|
|
for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) |