Enhance project rules and documentation structure
- Updated project rules to unify structure and interaction with tools, emphasizing the use of UV for package management and Windows PowerShell for terminal commands. - Added guidelines for argument validation and referencing documentation files for context and architecture. - Improved links in the README documentation for better navigation and accessibility to project resources. These changes aim to streamline project management and enhance clarity for developers, ensuring adherence to best practices and coding standards.
This commit is contained in:
@@ -3,6 +3,18 @@ description:
|
||||
globs:
|
||||
alwaysApply: true
|
||||
---
|
||||
- use UV for package management
|
||||
- ./docs folder for the documetation and the modules description, update related files if logic changed
|
||||
# Rule: Project specific rules
|
||||
|
||||
## Goal
|
||||
Unify the project structure and interraction with tools and console
|
||||
|
||||
### System tools
|
||||
- **ALWAYS** use UV for package management
|
||||
- **ALWAYS** use windows PowerShell command for terminal
|
||||
|
||||
### Coding patterns
|
||||
- **ALWYAS** check the arguments and methods before use to avoid errors with whron parameters or names
|
||||
- If in doubt, check [CONTEXT.md](mdc:CONTEXT.md) file and [architecture.md](mdc:docs/architecture.md)
|
||||
- **PREFER** ORM pattern for databases with SQLAclhemy.
|
||||
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ Before starting any refactoring, the AI MUST:
|
||||
1. **Context Analysis:**
|
||||
- Review existing `CONTEXT.md` for architectural decisions
|
||||
- Analyze current code patterns and conventions
|
||||
- Identify all files that will be affected
|
||||
- Identify all files that will be affected (search the codebase for use)
|
||||
- Check for existing tests that verify current behavior
|
||||
|
||||
2. **Scope Definition:**
|
||||
|
||||
Reference in New Issue
Block a user