Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.02 KB

CONTRIBUTING.rst

File metadata and controls

47 lines (34 loc) · 2.02 KB

Contributing

Pull requests and issues are welcome.

Pull request requirements

All commit messages need to stick with the AngularJS commit convention I didn't use it from the project's beginning, but you can look at the log to see some examples.

The project is versioned semantically (version kept in setup.py), so the patch number needs to be incremented on every fix, perf and refactor_perf commit, while feat commits should change the minor version.

After creating a commit, run Tox to make sure that you did everything OK.

Remember to rebase onto master before submitting your pull request. Also, it's good to submit small pull requests with incremental changes that don't need implement an entire feature, in the spirit of trunk-based development.

Oh, and if you're contributing some documentation (README, docstrings), it's good to run it through a spell checker (hunspell is good for command-line usage)

Hints

If you don't have the Python versions required by Tox and you're on Ubuntu, you can install them from the Deadsnakes repository.

Warnings

Right now there's a bug in the tests, so they can seldom fail or hang. I'm investigating it right now. It doesn't appear to affect the tests of software using Mountepy (like my PyDAS project).

If your branch can't fast forward when merging with with master, the automated check will say that the commit needs to be in AngularJS format, because a merge commit will be created.