Skip to content

agents: update news and PR conventions #4138

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
Sep 2, 2026
+9 −3
Merged

agents: update news and PR conventions #4138

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
10 changes: 7 additions & 3 deletions .agents/rules/news.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ Before drafting any news entry, adhere strictly to the rules in
`CONTRIBUTING.md` above.

## Sphinx MyST Cross-Reference Syntax (`{obj}`)
* Use `{obj}\`<symbol>\`` in news entries for rules, macros, targets, providers,
attributes, args, and any other cross-referencable Starlark or Python
objects.
* Use `{obj}\`<symbol>\`` only for cross-referencable Starlark or Python API
symbols (rules, macros, targets, providers, attributes, args).
* Never use `{obj}` on metadata files (e.g. `RECORD`), file paths, or tools.

## Content
* State user-visible behavior and outcomes (what now works, what changed).
* Omit internal implementation and refactoring details.

## GitHub Issue Link Formatting
* Append GitHub issue cross-references at the end of news entries in markdown
Expand Down
2 changes: 2 additions & 0 deletions .agents/rules/pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,5 @@ Before drafting any pull request description, strictly adhere to the rules in
conceptual level. Link related issues (e.g. `Work towards #<issue>`).
* **Conciseness & Style (Strunk & White)**: Omit needless words. Use clear,
active, and direct phrasing for *why* and *how*.
* **Preserve Existing Descriptions**: Preserve the author's wording unless
instructed to change it. Wrap bodies at 72 columns.