From 5969bbd0f30953f1d55cb63b524e7d1ab3ae1dc3 Mon Sep 17 00:00:00 2001 From: Landon Jurgens Date: Thu, 21 Jul 2016 11:54:13 -0400 Subject: [PATCH] Initial implementation of the contribution file Added IDE/TOOLS section to .gitignore --- .gitignore | 4 ++++ CONTRIBUTING.rst | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/.gitignore b/.gitignore index 2071634..fd1de91 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,8 @@ __pycache__/ .tox/ *.swp *.pyc +.coverage.* TODO + +IDE and Tooling files +.idea/* \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..5392a70 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,33 @@ +Contributing to Channels +======================== + +As an open source project, Channels welcomes contributions of many forms.By participating in this project, you +agree to abide by the Django `code of conduct `_. + +Examples of contributions include: + +* Code patches +* Documentation improvements +* Bug reports and patch reviews + +Setup +----- + +Fork, then clone the repo: + + git clone git@github.com:your-username/channels.git + +Make sure the tests pass: + + tox + +Make your change. Add tests for your change. Make the tests pass: + + tox + +Push to your fork and `submit a pull request `_. + + +At this point you're waiting on us. We like to at least comment on pull requests +within three business days (and, typically, one business day). We may suggest +some changes or improvements or alternatives.