Skip to content

Commit d7f7b7b

Browse files
committed
Commit message conventions
1 parent df947d7 commit d7f7b7b

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,15 @@ Please also update the docs using `sphinx`
3030

3131

3232
```
33-
bash scripts/mkdocs.sh #projectnamehere
33+
bash scripts/mkdocs.sh
3434
```
3535

36+
**Commit messages**
3637

37-
* Releasing
38+
Please write commit messages in the format "Extends functionality" instead of "Extended functionality".
3839

39-
Before releasing, please ensure that you have updated version in `version.py` and that the release on GitHub follows
40-
the structure `v#versionhere` e.g. `v0.2.1`.
40+
41+
**Releasing**
4142

4243
```shell
4344
bash scripts/release.sh

docs/source/CONTRIBUTING.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ Please also update the docs using ``sphinx``
3737

3838
.. code-block::
3939
40-
bash scripts/mkdocs.sh #projectnamehere
40+
bash scripts/mkdocs.sh
4141
42+
**Commit messages**
4243

43-
* Releasing
44+
Please write commit messages in the format "Extends functionality" instead of "Extended functionality".
4445

45-
Before releasing, please ensure that you have updated version in ``version.py`` and that the release on GitHub follows
46-
the structure ``v#versionhere`` e.g. ``v0.2.1``.
46+
**Releasing**
4747

4848
.. code-block:: shell
4949

0 commit comments

Comments
 (0)