summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2016-12-24 09:04:07 -0500
committerJason R. Coombs <jaraco@jaraco.com>2016-12-24 09:04:07 -0500
commit3cfb5fc4ca0671e16c694dc88be48c4df7c7a53e (patch)
tree8f24a689022d752d7a7bde90939e9e3e2d6ef9fc /docs
parentf8baa0e13ff9f2f4f0044603f729e72496abab64 (diff)
downloadcherrypy-git-3cfb5fc4ca0671e16c694dc88be48c4df7c7a53e.tar.gz
Flesh out the contribute section in the docs. Reference it from the CONTRIBUTING.txt file in the repo.
Diffstat (limited to 'docs')
-rw-r--r--docs/contribute.rst56
1 files changed, 54 insertions, 2 deletions
diff --git a/docs/contribute.rst b/docs/contribute.rst
index 94bdf2c0..0e2ebc61 100644
--- a/docs/contribute.rst
+++ b/docs/contribute.rst
@@ -1,6 +1,58 @@
-
Contribute
----------
+CherryPy is a community-maintained, open-source project hosted at Github.
+The project active encourages aspiring and experienced users to dive
+in and add their best contribution to the project.
+
+How can you contribute? Well, first search the `docs
+<https://docs.cherrypy.org>`_ and the `project page
+<https://github.com/cherrypy/cherrypy`_ to see if someone
+has already reported your issue.
+
+StackOverflow
+=============
+
+On `StackOverflow <https://stackoverflow.com>`_, there are questions
+tagged with 'cherrypy'. Answer unanswered questions, add an improved
+answer, clarify an answer with a comment, or ask more meaningful
+questions there. Earn reputation and share experience.
+
+CherryPy also maintains a `StackOverflow Wiki
+<http://stackoverflow.com/documentation/cherrypy/topics>`_ where
+anyone can publish tricks and techniques and refine others.
+
+Filing Bug Reports
+==================
+
+If you find a bug, an issue where the product doesn't behave as you
+expect, you may file a bug report at `the project page
+<https://github.com/cherrypy/cherrypy>`_. Be sure to include
+what your expectation was, what happened instead, details about
+your system that might be relevant, and steps that someone else
+could take to replicate your finding. The more detailed and exact
+your description, the better one of the volunteers on the project may
+be able to help resolve your issue.
+
+Fixing Bugs
+===========
+
+CherryPy has a number of open, reported `issues
+https://github.com/cherrypy/cherrypy/issues`_. Some of them are
+complicated and difficult, but others are more straightforward and
+shovel-ready. Feel free to find one that you think you can solve or
+introduce yourself and ask for guidance in `our gitter channel
+<https://gitter.im/cherrypy/cherrypy>`_.
+
+As you work through the issue and commit changes to your clone
+of the repository, be sure to add issue references to your changes
+(like "Fixes #999" or "Ref #999") so your changes link to the
+issue and vice-versa.
+
+Writing Pull Requests
+=====================
-To be done.
+To contribute, first read `How to write the perfect pull request
+<http://blog.jaraco.com/how-to-write-perfect-pull-request/>`_
+and file your contribution with the `CherryPy Project page
+<https://github.com/cherrypy/cherrypy>`_.