Skip to content

Commit 208a338

Browse files
committed
Adds AGENTS.md.
Establishes some rules that we would like AI agents to follow when creating issues or pull requests.
1 parent ed3fcae commit 208a338

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

AGENTS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Issues
2+
3+
- For non-trivial issues, include a link to a sample project that reproduces the issue.
4+
- Assume all versions to be that of the latest release. Only specify versions that deviate from that.
5+
- Specify dependencies only if the problem exists for one version or variant, but not for others.
6+
- Don't repeat information specified in the reference reproducer.
7+
- Add `Issue created by AI` to the issue description.
8+
9+
## Pull requests
10+
11+
- If there is an issue that gets fixed by this PR, add the keyword `Closes #<issue number>` to the PR description.
12+
- Add `PR created by AI` to the PR description.
13+
- If the change is not trivial, make sure there exists an issue for it.
14+
- Make the description short.
15+
- Do not repeat information.
16+
- Avoid superfluous embellishments.
17+
- Use formatting sparingly.
18+
- Do not repeat information contained in the issue description.
19+
- Make sure the PR builds successfully, including tests.
20+
- Make sure the PR contains tests for changed behavior.
21+
- Make sure the PR adheres to the contribution guidelines: https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc.

0 commit comments

Comments
 (0)