@@ -42,6 +42,18 @@ For specific files:
42
42
Don't run ` rails_best_practices ` to analyze individual files, as
43
43
it needs the full context to do its best.
44
44
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
+
45
57
### Development Environment Shortcut
46
58
47
59
As a convenience, in the development environment you don't need to use
@@ -205,10 +217,14 @@ Key environment variables for development:
205
217
- ` lib/tasks/default.rake ` - CI pipeline and custom tasks
206
218
- ` test/ ` - Comprehensive test suite
207
219
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
+
208
227
## Miscellaneous
209
228
210
229
IMPORTANT: Never have trailing whitespace in text-like files including
211
230
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