You are very welcome to submit code features or doc changes for review and merge into the central git repository:
- Create an issue
- Create a git branch with the format
ISSUE_NUMBER-brief-one-line-synopsis-of-the-work
- Commit and push your changes and write tests for your code
- Use PEP8, where possible
- Make sure all tests are passing
- Add a note to the
CHANGELOG.md
- Add new requirements to
setup.py
- Send a pull request and have someone to review it
For small changes and doc changes, it is not necessary to file a pull request.
Generally, follow the commit guidelines from the Pro Git book:
- Try to make each commit a logically separate, digestible changeset.
- The first line of the commit message should concisely summarise the changeset.
- Optionally, follow with a blank line and then a more detailed explanation of the changeset.
- Use the imperative present tense as if you were giving commands to the codebase to change its behaviour, e.g. Add tests for..., make xyzzy do frotz..., this helps to make the commit message easy to read.
- If your commit has an issue in the messytables issue tracker put the issue number at the start of the first line of the commit message like this: [#123].
source pyenv/messytables/bin/activate
python setup.py develop
pip install -r requirements-test.txt
nosetests
If you're reviewing a pull request for messytables, when merging a branch into master:
- Use the
--no-ff
option in thegit merge
command
If you want to release a new version:
- Make sure everything works as expected and all features are reasonably stable
- Tag the HEAD using semantic versioning and push them (
git push --tags
) - Push to PyPi