Skip to content

Commit 002313d

Browse files
author
erict875
committed
Add project description and PR quality gate guidelines to AGENTS.md
1 parent 07f3332 commit 002313d

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Repo Guidelines
22

3+
## Description
4+
A simple Java client for ACINQ's [phoenixd REST API](https://phoenix.acinq.co/server/api). It wraps the HTTP endpoints and exposes typed requests and responses.
5+
6+
37
## Testing
48

59
- Always run `mvn -q verify` from the repository root before committing your changes.
@@ -22,3 +26,15 @@
2226
- Add a "Network Access" section summarizing blocked domains if network requests were denied.
2327
- Ensure all new features, modules, or dependencies are properly documented in the `README.md` file.
2428
- Always follow the repository's PR submission guidelines and use the PR template located at `.github/pull_request_template.md`.
29+
30+
## PR Quality Gate
31+
32+
- PR summaries must reference modified files with file path citations (e.g. `F:path/to/file.java†L1-L2`).
33+
- PR titles and commit messages must follow the `type: description` naming format.
34+
- Allowed types: feat, fix, docs, refactor, test, chore, ci, build, perf, style.
35+
- The description should be a concise verb + object phrase (e.g., `refactor: Refactor auth middleware to async`).
36+
- Include a Testing section listing the commands run. Prefix each command with ✅, ⚠️, or ❌ and cite relevant terminal output.
37+
- If network requests fail, add a Network Access section noting blocked domains.
38+
- When TODOs or placeholders remain, include a Notes section.
39+
- Review AI-generated changes with developer expertise, ensuring you understand why the code works and that it remains resilient, scalable, and secure.
40+
- Use `rg` for search instead of `ls -R` or `grep -R`.

0 commit comments

Comments
 (0)