docs(src): syntax highlighting and content in contrib

davidvuong · Nov 5, 2015 · 583b836 · 583b836
1 parent 431d102
commit 583b836
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/src/contribute.rst b/docs/src/contribute.rst
@@ -1,7 +1,15 @@
 Contributing to PyNodeBB
 ========================
 
-Before contributing, please read the `contribution guide <https://github.com/davidvuong/pynodebb/blob/master/CONTRIBUTING.md>`_ on GitHub.
+    *All code in any code-base should look like a single person typed it, no matter how many people contributed.*
+
+The following are a few rules you need to follow when contributing to ``pynodebb``.
+
+* Please follow PEP8... or to the best of your ability... and when it makes sense.
+
+    *All I want to say is, people lighten up. The style guide can't solve all your problems. You are never going to have all code compliant. Use the style guide when it helps, ignore it when it's in the way.* -- Guido van Rossum
+
+* When documenting your code, please follow the Google Style Docstrings. Here's an `example <http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html>`_.
 
 1. Fork the PyNodeBB `repository <https://github.com/davidvuong/pynodebb>`_ on GitHub.
 
@@ -23,4 +31,4 @@ Before contributing, please read the `contribution guide <https://github.com/dav
 
 4. Make your awesome changes.
 
-5. Submit a PR on `GitHub <https://github.com/davidvuong/pynodebb/pulls>`_.
+5. Submit a pull request on `GitHub <https://github.com/davidvuong/pynodebb/pulls>`_.
diff --git a/docs/src/getstarted.rst b/docs/src/getstarted.rst
@@ -13,7 +13,8 @@ To re-cap, make sure that you've:
 
 The next step is to start using the PyNodeBB client.
 
-.. code:: python
+.. code-block:: python
+    :linenos:
 
     from __future__ import print_function
     from pynodebb import Client