From bb8f2ad7577fd313d3c60cb8c2e9d7f3b8350f08 Mon Sep 17 00:00:00 2001 From: dxdrummer Date: Sun, 9 Jun 2019 00:13:48 -0700 Subject: [PATCH 1/3] Adding Contribution Guidelines for Tornado After reading through the repository I saw a request to add contribution guidelines so decided to create them. This is one of my first contributions so I may be missing information, if so please let me know what I should add/edit to make this acceptable --- CONTRIBUTING.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..db353bb344 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +Contributing to Tornado Web Server +================== + +.. image:: https://badges.gitter.im/Join%20Chat.svg + :alt: Join the chat at https://gitter.im/tornadoweb/tornado + :target: https://gitter.im/tornadoweb/tornado?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge + + +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 `__ + From 2ef7c2bc3900356ca02530cbbc5bcb66b54dd65d Mon Sep 17 00:00:00 2001 From: dxdrummer Date: Sun, 9 Jun 2019 00:15:38 -0700 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db353bb344..ecc5f0119a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,6 @@ Contributing to Tornado Web Server ================== - -.. image:: https://badges.gitter.im/Join%20Chat.svg - :alt: Join the chat at https://gitter.im/tornadoweb/tornado - :target: https://gitter.im/tornadoweb/tornado?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +Join the chat at https://gitter.im/tornadoweb/tornado Tornado Web Server is an open source Python web framework and asynchronous networking library, originally developed at FriendFeed. From 4de5abc1dc8724f740401eca240e3bfd26b611bf Mon Sep 17 00:00:00 2001 From: dxdrummer Date: Sun, 9 Jun 2019 00:16:17 -0700 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecc5f0119a..deecdc1390 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,5 @@ Contributing to Tornado Web Server -================== -Join the chat at https://gitter.im/tornadoweb/tornado - +================== Tornado Web Server is an open source Python web framework and asynchronous networking library, originally developed at FriendFeed.