Skip to content

Document PR quality gate rules in AGENTS.md #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tcheeric merged 3 commits into from
Aug 19, 2025
Merged

Document PR quality gate rules in AGENTS.md #390

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f45e2fd
docs: document PR quality gate rules
tcheeric Aug 19, 2025
eeebe39
docs: document naming format requirements
tcheeric Aug 19, 2025
2490c32
docs: emphasize human expertise for AI
tcheeric Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,13 @@ The URL format for the NIPs is https://github.com/nostr-protocol/nips/blob/maste
- Summarize the changes made and describe how they were tested.
- Include any limitations or known issues in the description.
- Add a "Network Access" section summarizing blocked domains if network requests were denied.
- Ensure all new features, modules, or dependencies are properly documented in the `README.md` file.
- Ensure all new features, modules, or dependencies are properly documented in the `README.md` file.
## PR Quality Gate

- PR summaries must reference modified files with file path citations (e.g. `F:path/to/file.java†L1-L2`).
- PR titles and commit messages must follow the `type: description` naming format (e.g., `docs: update AGENTS`).
- Include a Testing section listing the commands run. Prefix each command with ✅, ⚠️, or ❌ and cite relevant terminal output.
- If network requests fail, add a Network Access section noting blocked domains.
- When TODOs or placeholders remain, include a Notes section.
- Review AI-generated changes with developer expertise, ensuring you understand why the code works and that it remains resilient, scalable, and secure.
- Use `rg` for search instead of `ls -R` or `grep -R`.
Loading