Skip to content

Commit

Permalink
DOC: add tests to git style
Browse files Browse the repository at this point in the history
Adding tests (tst) to the branch naming conventions in the git style page.
  • Loading branch information
lucasfourier committed Nov 28, 2023
1 parent 1916956 commit 622439b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/development/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ So here are a couple of **guidelines** to help you when creating new branches to
#. ``enh``: when you add new features and enhancements
#. ``maint``: when your branch is all about refactoring, fixing typos, etc.
#. ``rel``: when your branch makes changes related to creating new releases
#. ``tst``: when your branch makes changes related to tests

* Use ``-`` instead of spaces for the description text.
* Keep branch names with lowercase letters.
Expand All @@ -80,6 +81,7 @@ Here are a couple of example branch names:
- ``bug/issue-98-upside-down-rockets``
- ``enh/hybrid-motor-feature``
- ``maint/typos-flight-class``
- ``tst/refactor-tests-flight-class``

Once you are ready to create a Pull Request for your branch, we advise you to merge with the ``develop`` branch instead of the default ``master`` branch.
This way, we keep the ``master`` branch stable and use the ``develop`` branch to test out new features!
Expand Down

0 comments on commit 622439b

Please sign in to comment.