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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+37-8Lines changed: 37 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,13 +33,41 @@ make test
33
33
34
34
# Deploy to test
35
35
make deploy
36
-
✏️ Making Changes
37
-
Configuration Changes
38
-
1. Edit the main config: config.toml 2. Add reference files: Place in appropriate subdirectory (aliases/, revsets/, etc.) 3. Update documentation: Reflect changes in relevant README files
39
-
Documentation Changes
40
-
1. Follow markdown best practices 2. Use proper headings (H1-H6) 3. Include code examples with syntax highlighting 4. Add emojis for visual appeal (sparingly) 5. Test all links
41
-
Adding New Features
42
-
1. Create reference file in appropriate directory 2. Add to README in that directory 3. Update main README if user-facing 4. Add to TASKS.md if part of roadmap
36
+
## ✏️ Making Changes
37
+
38
+
### The Golden Workflow
39
+
40
+
Follow this "Inner Loop" to ensure quality and security:
41
+
42
+
#### 1. The Inner Loop (Iterate)
43
+
>**Goal**: Get the code working and documented locally.
44
+
1. **Code**: `micro config.toml` (Edit your files)
45
+
2. **Test**: `make test` or `trunk check` (Verify immediately)
46
+
3. **Docs**: Update `README.md` or `alias/*.md`**in parallel** with code changes.
0 commit comments