DOC: I took more documentation from the pypi README page and added it to the

Sphinx documentation.
This commit is contained in:
Tobias Brandt
2012-11-14 13:18:55 +02:00
parent e955012fce
commit 51838dbdd3
3 changed files with 121 additions and 8 deletions
+40
View File
@@ -0,0 +1,40 @@
***************************
Contributing to the project
***************************
Style Guide
===========
To ensure that changes and patches are focused on behavior changes,
the zipline codebase adheres to PEP-8,
`<http://www.python.org/dev/peps/pep-0008/>`_.
The maintainers check the code using the flake8 script,
`<https://github.com/jcrocholl/pep8/>`_, which is included in the
requirements_dev.txt.
Before submitting patches or pull requests, please ensure that your
changes pass
::
flake8 --ignore=E124,E125,E126 zipline tests
Discussion and Help
===================
Discussion of the project is held at the Google Group,
`<zipline@googlegroups.com>`_,
`<https://groups.google.com/forum/#!forum/zipline>`_.
Source
======
The source for Zipline is hosted at
`<https://github.com/quantopian/zipline>`_.
Contact
=======
For other questions, please contact `<opensource@quantopian.com>`_.