Merge pull request #163 from ryanpetrello/next
Updated documentation and instructions for contributing.
This commit is contained in:
20
CONTRIBUTING.rst
Normal file
20
CONTRIBUTING.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
Contributing to Pecan
|
||||
---------------------
|
||||
To fix bugs or add features to Pecan, a GitHub account is required.
|
||||
|
||||
The general practice for contributing is to `fork Pecan
|
||||
<http://help.github.com/fork-a-repo/>`_ and make changes in the ``next``
|
||||
branch. When you're finished, `send a pull request
|
||||
<http://help.github.com/send-pull-requests/>`_ and the developers will review
|
||||
your patch.
|
||||
|
||||
All contributions must:
|
||||
|
||||
* Include accompanying tests.
|
||||
* Include narrative and API documentation if new features are added.
|
||||
* Be (generally) compliant with `PEP8
|
||||
<http://www.python.org/dev/peps/pep-0008/>`_.
|
||||
* Not break the test or build. Before issuing a pull request, ``$ pip
|
||||
install tox && tox`` from your source to ensure that all tests still pass
|
||||
across multiple versions of Python.
|
||||
* Add your name to the (bottom of the) AUTHORS file.
|
||||
21
README.rst
21
README.rst
@@ -44,27 +44,6 @@ Viewing Documentation
|
||||
$ cd docs && make man
|
||||
$ man docs/build/man/pecan.1
|
||||
|
||||
Contributing to Pecan
|
||||
---------------------
|
||||
To fix bugs or add features to Pecan, a GitHub account is required.
|
||||
|
||||
The general practice for contributing is to `fork Pecan
|
||||
<http://help.github.com/fork-a-repo/>`_ and make changes in the ``next``
|
||||
branch. When you're finished, `send a pull request
|
||||
<http://help.github.com/send-pull-requests/>`_ and the developers will review
|
||||
your patch.
|
||||
|
||||
All contributions must:
|
||||
|
||||
* Include accompanying tests.
|
||||
* Include narrative and API documentation if new features are added.
|
||||
* Be (generally) compliant with `PEP8
|
||||
<http://www.python.org/dev/peps/pep-0008/>`_.
|
||||
* Not break the test or build. Before issuing a pull request, ``$ pip
|
||||
install tox && tox`` from your source to ensure that all tests still pass
|
||||
across multiple versions of Python.
|
||||
* Add your name to the (bottom of the) AUTHORS file.
|
||||
|
||||
Additional Help/Support
|
||||
-----------------------
|
||||
Most Pecan interaction is done via the #pecanpy channel on `FreeNode
|
||||
|
||||
@@ -42,6 +42,7 @@ Narrative Documentation
|
||||
jsonify.rst
|
||||
commands.rst
|
||||
development.rst
|
||||
deployment.rst
|
||||
logging.rst
|
||||
testing.rst
|
||||
|
||||
@@ -55,7 +56,6 @@ Cookbook and Common Patterns
|
||||
sessions.rst
|
||||
databases.rst
|
||||
errors.rst
|
||||
deployment.rst
|
||||
|
||||
|
||||
API Documentation
|
||||
|
||||
@@ -278,3 +278,7 @@ add to. To run them::
|
||||
OK
|
||||
|
||||
The tests themselves can be found in the ``tests`` module in your project.
|
||||
|
||||
Deploying to a Web Server
|
||||
-------------------------
|
||||
Ready to deploy your new Pecan app? Take a look at :ref:`deployment`.
|
||||
|
||||
Reference in New Issue
Block a user