Add AGENTS.md with project guidelines
Document GNOME commit style, code principles, testing, and security practices for contributors. Changes: - Include commit guidelines - Code style notes - Testing and security reminders
This commit is contained in:
parent
9b7a6c5c07
commit
c06474dd0d
1 changed files with 17 additions and 0 deletions
17
AGENTS.md
Normal file
17
AGENTS.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Project Guidelines
|
||||
|
||||
## Commits
|
||||
Follow GNOME style: Summary <72 chars, imperative, no period. Body with bullet points for changes.
|
||||
|
||||
## Code
|
||||
- Classes for modularity, private attrs/methods (_prefix).
|
||||
- Avoid redundancy (e.g., single strip() calls).
|
||||
- Encapsulation over public access.
|
||||
|
||||
## Testing
|
||||
- Dry-run first, check logs/counts vs. Thunderbird.
|
||||
- Verify no duplicates or errors.
|
||||
|
||||
## Security
|
||||
- Never commit .env; use .env.example.
|
||||
- Private credentials, no hard-coded URLs.
|
||||
Loading…
Add table
Add a link
Reference in a new issue