django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-07-10 16:02:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add contributing page to docs

Browse Source
This commit is contained in:
Andrew Godwin 2016-08-23 20:06:37 -07:00
parent 9a7317f583
commit 3cc6f744a6
2 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/contributing.rst Normal file
View File

@ -0,0 +1,51 @@
Contributing
============
If you're looking to contribute to Channels, then please read on - we encourage
contributions both large and small, from both novice and seasoned developers.
What can I work on?
-------------------
We're looking for help with the following areas:
* Documentation and tutorial writing
* Bugfixing and testing
* Feature polish and occasional new feature design
* Case studies and writeups
You can find a particular list of what we're looking to work on right now
on the `ChannelsTasks Django wiki page <https://code.djangoproject.com/wiki/ChannelsTasks>`_,
but this is just a suggested list - any offer to help is welcome.
I'm interested, how should I get started?
-----------------------------------------
The best thing to do is to see if there's a `GitHub issue <https://github.com/andrewgodwin/channels/issues>`_
for the thing you wish to work on - if there is, leave a comment saying you're
going to take it on, and if not, open one describing what you're doing so there's
a place to record information around.
If you have questions, you can either open an issue with the questions detailed,
hop on the ``#django-channels`` channel on Freenode IRC, or email Andrew directly
at ``andrew@aeracode.org``.
I'm a novice contributor/developer - can I help?
------------------------------------------------
Of course - just get in touch like above and mention your experience level,
and we'll try the best we can to match you up with someone to mentor you through
the task.
Can you pay me for my time?
---------------------------
Thanks to Mozilla, we have a reasonable budget to pay people for their time
working on all of the above sorts of tasks and more. If you're interested in
working on something and being paid, you'll need to draw up a short proposal
and get it approved first - the wiki page above has more details, and if you're
interested, email andrew@aeracode.org to get the conversation started.

1
docs/index.rst
View File

@ -39,3 +39,4 @@ Contents:
faqs faqs
asgi asgi
community community
contributing