Skip to content

Commit 7f4e0f5

Browse files
pbolingCopilot
andcommitted
🐛 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]>
1 parent 4348b7b commit 7f4e0f5

1 file changed

Lines changed: 6 additions & 134 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -51,56 +51,6 @@ after running `bin/setup`. These include:
5151
- kettle-readme-backers
5252
- kettle-release
5353

54-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
55-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
56-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
57-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
58-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
59-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
60-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
61-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
62-
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
63-
64-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
65-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
66-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
67-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
68-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
69-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
70-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
71-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
72-
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
73-
74-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
75-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
76-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
77-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
78-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
79-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
80-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
81-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
82-
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
83-
84-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
85-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
86-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
87-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
88-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
89-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
90-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
91-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
92-
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
93-
94-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
95-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
96-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
97-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
98-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
99-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
100-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
101-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
102-
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
103-
10454
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
10555
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
10656
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
@@ -128,40 +78,8 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
12878
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
12979
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
13080

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-
15881
There are many Rake tasks available as well. You can see them by running:
15982

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-
16583
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 -- ...`.
16684

16785
## Appraisals
@@ -201,20 +119,10 @@ bundle exec rake test
201119

202120
### Spec organization (required)
203121

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.
218126

219127
## Lint It
220128

@@ -236,24 +144,8 @@ For more detailed information about using RuboCop in this project, please see th
236144

237145
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:
238146

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:
250-
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
251-
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
252-
253-
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
254-
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
255-
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
256-
- `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.
257149

258150
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
259151
- 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
292184
2. Run `bundle exec kettle-changelog`.
293185
3. Run `bundle exec kettle-release`.
294186

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-
315187
#### Manual process
316188

317189
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check

0 commit comments

Comments
 (0)