Skip to content

Adding Contribution Guidelines to Tornado Web Server #2675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/tornadoweb/tornado/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 <https://github.com/tornadoweb/tornado/issues/new>`__

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 <http://www.tornadoweb.org>`__
- `Mailing Lists: Discussions <https://groups.google.com/forum/#!forum/python-tornado>`__
- `Mailing Lists: Announcements <https://groups.google.com/forum/#!forum/python-tornado-announce>`__
- `README <https://github.com/tornadoweb/tornado/blob/master/README.rst>`__
- `Tornado Wiki <https://github.com/tornadoweb/tornado/wiki>`__