You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: DEV_GUIDE.md
+12-9
Original file line number
Diff line number
Diff line change
@@ -54,18 +54,19 @@ For our changelog generator to work well, the only thing you need to remember is
54
54
55
55
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:
56
56
57
-
| Change type | Standard keywords * | Magical keywords **|
\***Standard keywords**: For consistency, make sure you always use these. Example merge commit message:
66
67
67
68
```
68
-
`topotools.plot_connections` no longer accepts list of pores [api].
69
+
`topotools.plot_connections` no longer accepts list of pores [#api].
69
70
```
70
71
71
72
\****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
74
75
Optimized `topotools.find_neighbor_pores` which is now ~10X faster.
75
76
```
76
77
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.
78
81
79
82
### Merging `dev` onto `release`
80
83
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