summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorwinlu <derwinlu+git@gmail.com>2015-01-05 12:36:35 +0100
committerwinlu <derwinlu+git@gmail.com>2015-01-05 12:36:35 +0100
commit49481f60a54eed144b2d09d510e203f03fcdc2d4 (patch)
tree250b75c580833d16298b8b38023817b17e28a5ae /CONTRIBUTING.rst
parent30c4d0eaf38f13f442946be29243f881e0c5e1a7 (diff)
downloadpelican-49481f60a54eed144b2d09d510e203f03fcdc2d4.tar.gz
fix headers, this fixes issues with docs/contributing.rst throwing errors because of the different content structure
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 85d30c97..862cf7a7 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,5 +1,5 @@
Filing issues
--------------
+=============
* Before you file an issue, try `asking for help`_ first.
* If determined to file an issue, first check for `existing issues`_, including
@@ -9,7 +9,7 @@ Filing issues
.. _`existing issues`: https://github.com/getpelican/pelican/issues
How to get help
----------------
+===============
Before you ask for help, please make sure you do the following:
@@ -66,7 +66,7 @@ Once the above preparation is ready, you can contact people willing to help via
Remember to include all the information you prepared.
The #pelican IRC channel
-........................
+------------------------
* Because of differing time zones, you may not get an immediate response to your
question, but please be patient and stay logged into IRC — someone will almost
@@ -81,7 +81,7 @@ The #pelican IRC channel
Contributing code
------------------
+=================
Before you submit a contribution, please ask whether it is desired so that you
don't spend a lot of time working on something that would be rejected for a
@@ -89,7 +89,7 @@ known reason. Consider also whether your new feature might be better suited as
a plugin_ — you can `ask for help`_ to make that determination.
Using Git and GitHub
-....................
+--------------------
* `Create a new git branch`_ specific to your change (as opposed to making
your commits in the master branch).
@@ -116,7 +116,7 @@ Using Git and GitHub
turn your GitHub issue into a pull request containing your code.
Contribution quality standards
-..............................
+------------------------------
* Adhere to `PEP8 coding standards`_ whenever possible. This can be eased via
the `pep8 <http://pypi.python.org/pypi/pep8>`_ or `flake8