Skip to content

Commit 8e7c241

Browse files
authored
Update DEV_GUIDE.md
1 parent 86411db commit 8e7c241

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

DEV_GUIDE.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,19 @@ For our changelog generator to work well, the only thing you need to remember is
5454

5555
When merging your branch onto `dev`, as the merge message, describe what your pull request does concisely and preferably in a single sentence plus one of the following "standard" keywords:
5656

57-
| Change type | Standard keywords * | Magical keywords ** |
58-
|:-------------|:--------------------|:------------------------------------------------------|
59-
| New feature | `new` | `feature` , `added` |
60-
| Enhancement | `enh` | `revamped` , `improved` , `enhanced` , `optimized` |
61-
| Maintenance | `maint` | `backend` |
62-
| API change | `api` | `deprecated` , `changed` , `removed` , `modified` |
63-
| Bug fix | `bug` | `bugfix` , `hotfix` , `fixed` |
57+
| Change type | Standard keywords * | Magical keywords ** |
58+
|:-------------|:---------------------|:------------------------------------------------------|
59+
| New feature | `#new` | `feature` , `added` |
60+
| Enhancement | `#enh` | `revamped` , `improved` , `enhanced` , `optimized` |
61+
| Maintenance | `#maint` | `backend` |
62+
| API change | `#api` | `deprecated` , `changed` , `removed` , `modified` |
63+
| Bug fix | `#bug` | `bugfix` , `hotfix` , `fixed` |
64+
| Documentation| `#doc` | `documentation` , `docstring` |
6465

6566
\* **Standard keywords**: For consistency, make sure you always use these. Example merge commit message:
6667

6768
```
68-
`topotools.plot_connections` no longer accepts list of pores [api].
69+
`topotools.plot_connections` no longer accepts list of pores [#api].
6970
```
7071

7172
\** **Magical keywords**: For ease of use - and also in case you forget to use standard keywords -, feel free to use these in your merge commit message, they will automatically get caught. Example merge commit message:
@@ -74,7 +75,9 @@ When merging your branch onto `dev`, as the merge message, describe what your pu
7475
Optimized `topotools.find_neighbor_pores` which is now ~10X faster.
7576
```
7677

77-
**Note**: You can use multiple keywords in case your pull request is doing multiple things (e.g. fixes a bug + deprecates a method), although this is discouraged. Please make a separate pull request for every change.
78+
**Note 1**: You can use multiple keywords in case your pull request is doing multiple things (e.g. fixes a bug + deprecates a method), although this is discouraged. Please make a separate pull request for every change.
79+
80+
**Note 2**: We're deprecating the magical keywords from `v2.6.0`, so only use the special keywords.
7881

7982
### Merging `dev` onto `release`
8083
Finally, if we're ready to publish a new release to PyPI and `conda`, you should create a pull request, asking to merge the `dev` branch onto the `release` branch. Again, this process is automated so that the version number gets bumped accordingly. The only thing you need to remember is to use the proper keyword, so that our automated workflow knows how to bump the version number. Please use the following keywords:

0 commit comments

Comments
 (0)