Development Guidelines ====================== This page is intended for developers of Catalyst, people who want to contribute to the Catalyst codebase or documentation, or people who want to install from source and make local changes to their copy of Catalyst. All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We `track issues `_ on `GitHub `_ and also have a `discord group `_ where you can ask questions. Creating a Development Environment ---------------------------------- First, you'll need to clone Catalyst by running: .. code-block:: bash $ git clone git@github.com:enigmampc/catalyst.git Then check out to a new branch where you can make your changes: .. code-block:: bash $ git checkout -b some-short-descriptive-name If you don't already have them, you'll need some C library dependencies. You can follow the `install guide `_ to get the appropriate dependencies. The following section assumes you already have virtualenvwrapper and pip installed on your system. Suggested installation of Python library dependencies used for development: .. code-block:: bash $ mkvirtualenv catalyst $ ./etc/ordered_pip.sh ./etc/requirements.txt $ pip install -r ./etc/requirements_dev.txt $ pip install -r ./etc/requirements_blaze.txt Finally, you can build the C extensions by running: .. code-block:: bash $ python setup.py build_ext --inplace .. To finish, make sure `tests`__ pass. .. __ #style-guide-running-tests .. If you get an error running nosetests after setting up a fresh virtualenv, please try running .. code-block .. # where zipline is the name of your virtualenv .. $ deactivate zipline .. $ workon zipline .. Development with Docker .. ----------------------- ..If you want to work with zipline using a `Docker`__ container, you'll need to build the ``Dockerfile`` in the Zipline root directory, and then build ``Dockerfile-dev``. Instructions for building both containers can be found in ``Dockerfile`` and ``Dockerfile-dev``, respectively. .. __ https://docs.docker.com/get-started/ Git Branching Structure ----------------------- If you want to contribute to the codebase of Catalyst, familiarize yourself with our branching structure, a fairly standardized one for that matter, that follows what is documented in the following article: `A successful Git branching model `_. To contribute, create your local branch and submit a Pull Request (PR) to the **develop** branch. .. image:: https://camo.githubusercontent.com/9bde6fb64a9542a572e0e2017cbb58d9d2c440ac/687474703a2f2f6e7669652e636f6d2f696d672f6769742d6d6f64656c4032782e706e67 Contributing to the Docs ------------------------ If you'd like to contribute to the documentation on enigmampc.github.io, you can navigate to ``docs/source/`` where each `reStructuredText `_ file is a separate section there. To add a section, create a new file called ``some-descriptive-name.rst`` and add ``some-descriptive-name`` to ``index.rst``. To edit a section, simply open up one of the existing files, make your changes, and save them. We use `Sphinx `_ to generate documentation for Catalyst, which you will need to install by running: .. code-block:: bash $ pip install -r ./etc/requirements_docs.txt To build and view the docs locally, run: .. code-block:: bash # assuming you're in the Catalyst root directory $ cd docs $ make html $ {BROWSER} build/html/index.html Commit messages --------------- Standard prefixes to start a commit message: .. code-block:: text BLD: change related to building Catalyst BUG: bug fix DEP: deprecate something, or remove a deprecated object DEV: development tool or utility DOC: documentation ENH: enhancement MAINT: maintenance commit (refactoring, typos, etc) REV: revert an earlier commit STY: style fix (whitespace, PEP8, flake8, etc) TST: addition or modification of tests REL: related to releasing Catalyst PERF: performance enhancements Some commit style guidelines: Commit lines should be no longer than `72 characters `_. The first line of the commit should include one of the above prefixes. There should be an empty line between the commit subject and the body of the commit. In general, the message should be in the imperative tense. Best practice is to include not only what the change is, but why the change was made. **Example:** .. code-block:: text MAINT: Remove unused calculations of max_leverage, et al. In the performance period the max_leverage, max_capital_used, cumulative_capital_used were calculated but not used. At least one of those calculations, max_leverage, was causing a divide by zero error. Instead of papering over that error, the entire calculation was a bit suspect so removing, with possibility of adding it back in later with handling the case (or raising appropriate errors) when the algorithm has little cash on hand. Formatting Docstrings --------------------- When adding or editing docstrings for classes, functions, etc, we use `numpy `_ as the canonical reference.