asp/keep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: implement rule to always keep project rules first in DESIGN.md

Browse Source 
Co-authored-by: aider (openai/andrew.openrouter.qwen.qwen3-coder) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-07-28 17:18:17 -03:00
parent 0f555f3316
commit a549fd6271
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
DESIGN.md
View File

@@ -1,5 +1,19 @@
# PROJECT RULES - KEEP FIRST
## Standard Rules
1. ALWAYS keep DESIGN.md updated with any architectural or design changes
2. ALWAYS keep project rules first in this document
3. Follow Rust naming conventions and idioms
4. Use anyhow for error handling throughout the codebase
5. Maintain comprehensive logging with the log crate
6. Write unit tests for critical functionality
7. Document public APIs with rustdoc comments
8. Keep modules focused on single responsibilities
9. Prefer composition over inheritance
10. Handle errors gracefully and provide meaningful error messages
11. Ensure code is safe and avoids unsafe blocks where possible
## Code - Modules
### Main Module
@@ -46,15 +60,3 @@
- `plugins.rs` - Shared plugin utilities
- Contains `ProgramWriter` for external process communication
## Standard Rules
1. ALWAYS keep DESIGN.md updated with any architectural or design changes
2. Follow Rust naming conventions and idioms
3. Use anyhow for error handling throughout the codebase
4. Maintain comprehensive logging with the log crate
5. Write unit tests for critical functionality
6. Document public APIs with rustdoc comments
7. Keep modules focused on single responsibilities
8. Prefer composition over inheritance
9. Handle errors gracefully and provide meaningful error messages
10. Ensure code is safe and avoids unsafe blocks where possible