|
| 1 | +# Contributing to Python-Project-Scripts |
| 2 | +Thanks for your interest in Python. Our goal is to bring fast, open-source python projects to all communities. |
| 3 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 4 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 5 | + |
| 6 | +- Reporting a bug |
| 7 | +- Discussing the current state of the code |
| 8 | +- Submitting a fix |
| 9 | +- Proposing new features |
| 10 | +- Becoming a maintainer |
| 11 | + |
| 12 | +## We Develop with Github |
| 13 | +We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| 14 | + |
| 15 | +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests |
| 16 | +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: |
| 17 | + |
| 18 | +1. Fork the repo and create your branch from `master`. |
| 19 | +2. If you've added code that should be tested, add tests. |
| 20 | +3. If you've changed APIs, update the documentation. |
| 21 | +4. Ensure the test suite passes. |
| 22 | +5. Make sure your code lints. |
| 23 | +6. Issue that pull request! |
| 24 | +7. Always add a READme to your added code. |
| 25 | + |
| 26 | +## Any contributions you make will be under the MIT Software License |
| 27 | +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. |
| 28 | + |
| 29 | +## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) |
| 30 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! |
| 31 | + |
| 32 | +## Write bug reports with detail, background, and sample code |
| 33 | +[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect. |
| 34 | + |
| 35 | +**Great Bug Reports** tend to have: |
| 36 | + |
| 37 | +- A quick summary and/or background |
| 38 | +- Steps to reproduce |
| 39 | + - Be specific! |
| 40 | + - Give sample code if you can. |
| 41 | +- What you expected would happen |
| 42 | +- What actually happens |
| 43 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 44 | + |
| 45 | +People *love* thorough bug reports. I'm not even kidding. |
| 46 | + |
| 47 | +## Use a Consistent Coding Style |
| 48 | + |
| 49 | +## License |
| 50 | +By contributing, you agree that your contributions will be licensed under its MIT License. |
| 51 | + |
| 52 | +## References |
| 53 | +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) |
0 commit comments