Skip to content

agents: refine commit type definitions and interface docstring rules #4063

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
rickeylev merged 1 commit into from
Aug 16, 2026
Merged

agents: refine commit type definitions and interface docstring rules #4063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions .agents/rules/pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@ Before drafting any pull request description, strictly adhere to the rules in

## Commit & PR Types
* `fix:` / `feat:`: User-visible changes ONLY.
* `workflow:` / `workflows:`: Internal workflow automation, release tooling, and
CI scripts (e.g., `workflow(release): ...`).
* `build:` / `build(release):`: Internal release tooling, developer workflows,
and build scripts (prefer `build(release):` over `chore:` or `tools:`, since
`tools:` could be ambiguous with production tools).
* `ci:`: `.bazelci` and Buildkite CI configurations.
* `workflow:` / `workflows:`: GitHub Actions workflow configurations
(`.github/workflows/`).
* `tests:`: Test-only changes and test-helper fixes (never `fix:` or
`fix(tests):`).

Expand Down
4 changes: 4 additions & 0 deletions .agents/rules/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
* Use direct attribute access (e.g. `args.foo`) on `argparse.Namespace` with
well-defined shapes. Avoid defensive `getattr()`.

## Interface & ABC Docstrings
* In abstract base class / interface methods, always document `Args:`,
`Returns:`, and all custom exceptions raised under `Raises:`.

## Exception Handling
* Inherit custom exceptions from `Exception`, not `RuntimeError`.

Expand Down