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: docs/design.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ Good development standards make for better code.
76
76
77
77
### Commit messages
78
78
79
-
> A well-cared for log is a beautiful and useful thing
79
+
> A well-cared for (commit) log is a beautiful and useful thing
80
80
81
81
This quote comes from the following article, which should be considered a mandatory read for anyone maintaining a package:
82
82
@@ -92,6 +92,25 @@ The summary, slightly adapted by personal preferences (indicated in boldface):
92
92
*[Use the body to explain what and why vs. how](https://cbea.ms/git-commit/#why-not-how).
93
93
94
94
In addition, try to make [atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/) when possible.
95
+
We've also taken inspiration from the [MyST parser contribution guide](https://github.com/executablebooks/MyST-Parser?tab=contributing-ov-file#commit-messages).[^1]
96
+
97
+
[^1]: Shoutout to my boi [Chris Sewell](https://github.com/chrisjsewell). The man, the legend. The quintessential British b***ard.
98
+
99
+
Here is an example of the desired format for a commit message:
100
+
101
+
```
102
+
<EMOJI> <SCOPE>: Summarize changes in 72 characters or less
103
+
104
+
More detailed explanatory text, if necessary. Explain the problem that this
105
+
commit is solving. Focus on why you are making this change and why you chose
106
+
your approach as opposed to what you are changing (the code explains that).
107
+
Are there side effects or other unintuitive consequences of this change?
108
+
Here's the place to explain the context of your commit to someone else reading
109
+
your message in the future (most likely you).
110
+
111
+
PS: There is no need to mention you also added unit tests when adding a new
0 commit comments