Skip to content

Commit b8005c8

Browse files
Merge pull request #2421 from coreinfrastructure/claude-2
Tweaks to CLAUDE.md
2 parents 266feb8 + 9af6664 commit b8005c8

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

CLAUDE.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ For specific files:
4242
Don't run `rails_best_practices` to analyze individual files, as
4343
it needs the full context to do its best.
4444

45+
### Workflow
46+
47+
After making significant changes to source code, ALWAYS
48+
run linters. If you changed any Ruby files, run `rubocop` on them,
49+
then run `rake rails_best_practices`. If you modify any markdown files,
50+
run `mdl` on them. After that, if you changed any files that will be
51+
checked in, run `rake whitespace_check`. Fix problems reported
52+
by the linters.
53+
54+
Once all linters pass, run `rails test:all` to ensure all
55+
tests pass.
56+
4557
### Development Environment Shortcut
4658

4759
As a convenience, in the development environment you don't need to use
@@ -205,10 +217,14 @@ Key environment variables for development:
205217
- `lib/tasks/default.rake` - CI pipeline and custom tasks
206218
- `test/` - Comprehensive test suite
207219

220+
## Temporary File Convention
221+
222+
- ALL temporary files' filenames must be prefixed with a comma
223+
(e.g., `,temp-notes.md`, `,migration-plan.txt`)
224+
- This applies to documentation, scratch files, migration plans, etc.
225+
- The linting tools are configured to ignore comma-prefixed files
226+
208227
## Miscellaneous
209228

210229
IMPORTANT: Never have trailing whitespace in text-like files including
211230
source code and markdown files.
212-
213-
IMPORTANT: When creating temporary files, always prefix their names with
214-
a comma to distinguish them.

0 commit comments

Comments
 (0)