mirror of
https://github.com/wassname/catalyst.git
synced 2026-07-14 11:15:09 +08:00
Adds information style guide, discussion, and contact info to README.
This commit is contained in:
@@ -84,3 +84,22 @@ Data sources have events with very different frequencies. For example, liquid st
|
||||
3. All datasources send all events in their history from before <date>, moving their internal pointer forward to the next unsent event.
|
||||
4. QBT merges all events in memory
|
||||
5. goto 1!
|
||||
|
||||
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 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>.
|
||||
|
||||
Contact
|
||||
=======
|
||||
|
||||
For other questions, please contact <opensource@quantopian.com>.
|
||||
|
||||
Reference in New Issue
Block a user