Skip to content

Commit 8b460f8

Browse files
authored
agents(pr): prohibit per-file edit lists in PR descriptions (bazel-contrib#3996)
Update the pull request rules to explicitly prohibit per-file edit lists or individual file changelog items in PR descriptions and commit messages. Reinforce that PR descriptions must provide a high-level overview explaining why a change is made and how at a conceptual level, and mandate linking related issues.
1 parent 16e167a commit 8b460f8

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

‎.agents/rules/pr.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
trigger: model_decision
3-
description: Apply when drafting pull request descriptions.
3+
description: rules to apply to pull request descriptions
44
---
55

66
@CONTRIBUTING.md
@@ -18,3 +18,7 @@ Before drafting any pull request description, strictly adhere to the rules in
1818
* Once a Pull Request is created, always make new commits or merge commits.
1919
* **NEVER** amend or rebase commits on an active PR branch to avoid breaking
2020
code review threads.
21+
* **NEVER** include a list of per-file edits or changelog bullet points of
22+
individual file modifications in PR descriptions or commit messages.
23+
* High-level overview only: state *why* the change is made and *how* at a
24+
conceptual level. Link related issues (e.g. `Work towards #<issue>`).

0 commit comments

Comments
 (0)