Skip to content

Commit a75c8fd

Browse files
committed
πŸ“š Design: explain priorities and bump dependency one
Sometimes there might be multiple types to choose from. At the moment I'm not sure if it's best to stick with one type specifier or specify multiple (e.g. new feature that needs a dependency). I want to be able to identify commits that change dependencies easily, but splitting them up makes the commit confusing, and using only the dependency type is a bit strange for a commit that adds a new feature.
1 parent de4d3af commit a75c8fd

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

β€Ždocs/design.mdβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,17 @@ Some advantages:
144144
Although we are in favor of using emojis in the subject line, we do **not** allow emojis in the body.
145145
This makes it easier to `grep` for commit types.
146146

147+
The list in the table below is in order of priority, e.g. a backwards-incompatible change might improve an existing feature by breaking its API, but should _not_ be typed as an improvement (πŸ‘Œ).
148+
Similarly, if a dependency is changed, it's convenient to quickly spot this, e.g. when updating a conda feedstock.
149+
147150
| Emoji | Meaning | Similar to [Angular type](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) | In changelog summary? |
148151
| ----- | ---------------------------------------------------------------- | ----------------------------------------- | ------------------------- |
149152
| πŸ’₯ | introduce a backward-incompatible (breaking) change / remove deprecated code | `\<type>!` (use `!` + `BREAKING CHANGE:`) | **Yes** |
153+
| πŸ“¦ | add, update or change a dependency | `build` | **Yes** |
150154
| ✨ | introduce new features | `feat` | **Yes** |
151155
| πŸ‘Œ | improve an existing code/feature (no breaking) | `perf`/`feat` | **Yes** |
152156
| πŸ› | fix a code bug | `fix` | **Yes** |
153157
| ❌ | mark code as deprecated (note removal version/replacement) | `refactor` | **Yes** |
154-
| πŸ“¦ | update or change a dependency | `build` | **Yes** |
155158
| πŸ“š | add or adapt documentation | `docs` | No |
156159
| πŸ”„ | refactor existing code with no behavior change | `refactor` | No |
157160
| πŸ§ͺ | add or adapt tests | `test` | No |

0 commit comments

Comments
Β (0)