diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..deecdc1390 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +Contributing to Tornado Web Server +================== + +Tornado Web Server is an open source Python web framework and asynchronous networking library, originally developed at FriendFeed. + +Tornado is driven by it's community and contributions are welcome. + +Before contributing, here are some steps to follow: + +Bug Reports +------------ + +When submitting a bug report: + +1. Check the existing `issues `_ to ensure it hasn't already been brought up/there isn't already a fix being worked on + +2. If there is no existing issue, attempt to reproduce the bug and record your steps. Be as specific as possible + +3. Open a new `issue here `__ + +4. Give a descriptive name of the issue caused by the bug and be as descriptive as possible when describing what the bug is doing and what steps you took to get there + + +Submitting Code +------------ + +When working on submitting new code to the repository: + +1. Fork the repository to create your own version to work on + +2. When ready to submit, if you had an open issue/we working on an existing issue please comment on the issue to state you are making a merge request + +3. Create a new pull request with detailed comments about what you are changing and why + +4. If your pull request is not merged, look for followup comments for what needs to be changed for it to make it into the master repository + + +If New: Familiarizing Yourself with Tornado +------------ + +- `Documentation `__ +- `Mailing Lists: Discussions `__ +- `Mailing Lists: Announcements `__ +- `README `__ +- `Tornado Wiki `__ +