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
🐛 Restore CONTRIBUTING.md from pre-corruption state
Reverted to b2b85fc (first kettle-jem v1.0.0 template run) which was
the last clean version. Subsequent runs duplicated the tool list,
coverage ENV vars, spec organization rules, rubocop gradual section,
and release steps — each block copied once per template run.
Co-authored-by: Copilot <[email protected]>
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
129
79
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
130
80
131
-
- gem_checksums
132
-
- kettle-changelog
133
-
- kettle-commit-msg
134
-
- kettle-dev-setup
135
-
- kettle-dvcs
136
-
- kettle-pre-release
137
-
- kettle-readme-backers
138
-
- kettle-release
139
-
140
-
- gem_checksums
141
-
- kettle-changelog
142
-
- kettle-commit-msg
143
-
- kettle-dev-setup
144
-
- kettle-dvcs
145
-
- kettle-pre-release
146
-
- kettle-readme-backers
147
-
- kettle-release
148
-
149
-
- gem_checksums
150
-
- kettle-changelog
151
-
- kettle-commit-msg
152
-
- kettle-dev-setup
153
-
- kettle-dvcs
154
-
- kettle-pre-release
155
-
- kettle-readme-backers
156
-
- kettle-release
157
-
158
81
There are many Rake tasks available as well. You can see them by running:
159
82
160
-
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
161
-
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
162
-
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
163
-
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
164
-
165
83
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
166
84
167
85
## Appraisals
@@ -201,20 +119,10 @@ bundle exec rake test
201
119
202
120
### Spec organization (required)
203
121
204
-
- gem_checksums
205
-
- kettle-changelog
206
-
- kettle-commit-msg
207
-
- kettle-dev-setup
208
-
- kettle-dvcs
209
-
- kettle-pre-release
210
-
- kettle-readme-backers
211
-
- kettle-release
212
-
213
-
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/version_gem/my_class.rb` -> `spec/version_gem/my_class_spec.rb`.
214
-
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
215
-
216
-
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/version_gem/my_class.rb` -> `spec/version_gem/my_class_spec.rb`.
217
-
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
122
+
1. Update version.rb to contain the correct version-to-be-released.
123
+
2. Run `bundle exec kettle-changelog`.
124
+
3. Run `bundle exec kettle-release`.
125
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
218
126
219
127
## Lint It
220
128
@@ -236,24 +144,8 @@ For more detailed information about using RuboCop in this project, please see th
236
144
237
145
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
238
146
239
-
- gem_checksums
240
-
- kettle-changelog
241
-
- kettle-commit-msg
242
-
- kettle-dev-setup
243
-
- kettle-dvcs
244
-
- kettle-pre-release
245
-
- kettle-readme-backers
246
-
- kettle-release
247
-
248
-
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
249
-
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
-`bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
147
+
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/version_gem/my_class.rb` -> `spec/version_gem/my_class_spec.rb`.
148
+
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
257
149
258
150
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
259
151
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
@@ -292,26 +184,6 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
292
184
2. Run `bundle exec kettle-changelog`.
293
185
3. Run `bundle exec kettle-release`.
294
186
295
-
1. Update version.rb to contain the correct version-to-be-released.
296
-
2. Run `bundle exec kettle-changelog`.
297
-
3. Run `bundle exec kettle-release`.
298
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
299
-
300
-
1. Update version.rb to contain the correct version-to-be-released.
301
-
2. Run `bundle exec kettle-changelog`.
302
-
3. Run `bundle exec kettle-release`.
303
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
304
-
305
-
1. Update version.rb to contain the correct version-to-be-released.
306
-
2. Run `bundle exec kettle-changelog`.
307
-
3. Run `bundle exec kettle-release`.
308
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
309
-
310
-
1. Update version.rb to contain the correct version-to-be-released.
311
-
2. Run `bundle exec kettle-changelog`.
312
-
3. Run `bundle exec kettle-release`.
313
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
314
-
315
187
#### Manual process
316
188
317
189
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
0 commit comments