Zipline development guidelines

Commit messages

Standard acronyms to start the commit message with are:

BLD: change related to building zipline
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)
TST: addition or modification of tests
REL: related to releasing Zipline
PERF: Performance enhancements

Pulling in Pull Requests (PRs)

Example for correctly pulling in PR 135.

(master) $ git checkout -b PR-135
$ curl https://github.com/quantopian/zipline/pull/135.patch | git am
# Clean up commit history
$ git rebase -i master
# Merge (use no-ff for many commits and ff for few)
$ git merge --no-ff --edit