-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
.gitmessage
216 lines (203 loc) · 10.4 KB
/
.gitmessage
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
feat: Add feature (use imperative mood)
# └── chore|content|docs|feat|fix|refactor|revert|style|test ──────────┤
# **Motivation - Why is this change necessary?**
Because
# **Impact - How will this commit address the need?**
this commit will:
- add
# **Context - Additional information** <!-- Optional section -->
# **Issues - What issues are involved?**
Resolves #123
**Certification**
- [ ] I certify that <!-- Check the box to certify: [X] -->
- I have read the [contributing guidelines](
https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
- I license these contributions to the public under Seedlingo's
[LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
and have the rights to do so.
# Signed-off-by: Name/username <email>
# ─── END OF COMMIT MESSAGE ───────────────────────────────────wrap<=72┘
# Examples (find Commit message guidelines further down)
# ─────────────────────────────────────────────────────────────────────┐
# refactor: Improve readability
#
# Because the original name is uninformative
# and make it unnecessarily hard to follow the logic,
#
# this commit will:
# - reduce effort needed to comprehend logic
# - rename varB to audioElement in InstructionsDirective.ts
#
# Resolves #123
#
# - [ ] I certify that <!-- Check the box to certify: [X] -->
# - I have read the [contributing guidelines](
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# - I license these contributions to the public under Seedlingo's
# [LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
# and have the rights to do so.
#
# Signed-off-by: gituser <email@address.com>
# ─────────────────────────────────────────────────────────────────────┘
#
# ─────────────────────────────────────────────────────────────────────┐
# docs: Contrast web and native in get_started.md
#
# Because users are confused and stuck when trying to install the PWA,
#
# this commit will:
# - clarify differences between the web/PWA experience,
# and the native app experience.
#
# Closes #123
# Refs #23 (will not auto-close issue)
#
# - [ ] I certify that <!-- Check the box to certify: [X] -->
# - I have read the [contributing guidelines](
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# - I license these contributions to the public under Seedlingo's
# [LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
# and have the rights to do so.
#
# Signed-off-by: gituser <email@address.com>
# ─────────────────────────────────────────────────────────────────────┘
#
# ─────────────────────────────────────────────────────────────────────┐
# fix: Prevent crash on return to home screen
#
# Because users experience a crashes when returning to home screen
# due to a hardcoded path that is incorrectly referenced,
#
# this commit will:
# - improve crash resilience for navigation
# - replace hardcoded path with named route for Home screen
# - add regression test
#
# Fixes #123
#
# - [ ] I certify that <!-- Check the box to certify: [X] -->
# - I have read the [contributing guidelines](
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# - I license these contributions to the public under Seedlingo's
# [LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
# and have the rights to do so.
#
# Signed-off-by: gituser <email@address.com>
# ─────────────────────────────────────────────────────────────────────┘
#
# ─────────────────────────────────────────────────────────────────────┐
# fix: Revert to broadly compatible format
#
# Users report audio not playing
# due to their system lacking support for <specific format>.
# A more widely supported format is <other format>,
# and the difference in compression is < 5%.
# Sound quality differences are negligible.
#
# This commit will:
# - revert all audio files to <other format>
# used prior to commit <some hash>
# - remove unused dependency
#
# Fixes #123
#
# - [ ] I certify that <!-- Check the box to certify: [X] -->
# - I have read the [contributing guidelines](
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# - I license these contributions to the public under Seedlingo's
# [LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
# and have the rights to do so.
#
# Signed-off-by: gituser <email@address.com>
# ─────────────────────────────────────────────────────────────────────┘
#
# ─────────────────────────────────────────────────────────────────────┐
# fix: Revert to broadly compatible format
#
# Because
# - users report audio not playing
# due to their systems lacking support for <specific format>
# - <other format> is more widely supported
# - difference in compression is < 5%
# - sound quality differences are negligible
#
# this commit will:
# - revert all audio files to <other format>
# used prior to commit <some hash>
# - remove unused dependency
#
# Fixes #123
#
# - [ ] I certify that <!-- Check the box to certify: [X] -->
# - I have read the [contributing guidelines](
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# - I license these contributions to the public under Seedlingo's
# [LICENSE](https://github.com/nodepa/seedlingo/blob/main/LICENSE.md)
# and have the rights to do so.
#
# Signed-off-by: gituser <email@address.com>
# ─────────────────────────────────────────────────────────────────────┘
# Commit message guidelines
# ─────────────────────────────────────────────────────────────────────┐
# <type>: <summary>
# └── chore|content|docs|feat|fix|refactor|revert|style|test ───────┤
#
# <motivation>
#
# <impact>
#
# <context>
#
# <issues>
#
# <certification>
# ─────────────────────────────────────────────────────────────wrap<=72┘
#
# Subject line: <type>: <summary>
# ─────────────────────────────────────────────────────────────────────┐
# Start with a <type> from this list (use lowercase):
# chore (maintenance/scripts/dependencies/config/infrastructure)
# content (add/fix/amend files in the content folder)
# docs (add/correct/improve docs/policies/templates/READMEs)
# feat (add new feature/functionality for the user)
# fix (fix bug for the user)
# refactor (code structure/readability/performance, no fix/feat)
# revert (revert a specific commit)
# style (amend code formatting/spelling/punctuation, no semantic)
# test (add missing tests or correct/refactor existing tests)
#
# Proceed to add a <summary> starting with an uppercase letter.
# Use the imperative mood ("Add feature", not "Added feature").
# Try to not exceed 50 characters and do not exceed 72 characters.
# Do not end the line with punctuation.
# ─────────────────────────────────────────────────────────────────────┘
#
# Message: <motivation><impact><context><issues><certification>
# ─────────────────────────────────────────────────────────────────────┐
# Wrap the message body at max 72 characters per line.
#
# Start the body of the message with the <motivation> for this commit.
# Try to answer: "Why is this change necessary?"
# Consider to start the answer with "Because".
#
# Next, you may describe the <impact> of the commit.
# Try to answer: "How does this commit respond to the needs?"
# Consider to start the answer with "This commit will:",
# followed by a list of actions (preferably) written in imperative mood.
# Leave the specifics to the actual code/changeset/diff.
#
# If there is a need to add any <other context>, like requirements,
# environment configurations or additional notes, add it here.
#
# Remember to reference relevant GitHub <issues>.
# Closes #123, fixes #123 and resolves #123
# are keywords that tell GitHub to automatically close those issues
# when the pull request is merged into the main branch.
#
# Finally, certify that you have read the contributing guidelines
# https://github.com/nodepa/seedlingo/blob/main/.github/CONTRIBUTING.md)
# and have the will and rights to publish the contribution to the public
# under this https://github.com/nodepa/seedlingo/blob/main/LICENSE.md.
# End with a sign-off (automatically added with 'git commit --signoff'):
# Signed-off-by: Name/username <email>
# ─────────────────────────────────────────────────────────────wrap<=72┘