Skip to content

Commit

Permalink
docs(contributing): trunk-based development
Browse files Browse the repository at this point in the history
  • Loading branch information
butla committed Oct 26, 2016
1 parent 13a0c19 commit 19e924a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.rst
Expand Up @@ -16,6 +16,8 @@ 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)
Expand All @@ -41,4 +43,5 @@ will say that the commit needs to be in AngularJS format, because a merge commit
.. _Deadsnakes repository: https://launchpad.net/~fkrull/+archive/ubuntu/deadsnakes
.. _hunspell: https://hunspell.github.io/
.. _Tox: https://tox.readthedocs.io/en/latest/
.. _trunk-based development: https://www.thoughtworks.com/insights/blog/enabling-trunk-based-development-deployment-pipelines
.. _versioned semantically: http://semver.org/

0 comments on commit 19e924a

Please sign in to comment.