Skip to content

Commit f017f09

Browse files
committed
Polishing.
Replace various issue templates to a single one aligning with Spring Boot and Framework setups.
1 parent 6fa8a8b commit f017f09

File tree

9 files changed

+122
-66
lines changed

9 files changed

+122
-66
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Community Support
4+
url: https://stackoverflow.com/tags/spring-data
5+
about: Please ask and answer questions on StackOverflow with the tag `spring-data`.

.github/ISSUE_TEMPLATE/do-not-submit-security-issues-on-github--see-https---spring-io-security-policy.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: General issue
3+
about: Bugs, enhancements, documentation, tasks.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!--
10+
Thanks for raising a Spring Data issue. Please take the time to review the following
11+
categories as some of them do not apply here:
12+
13+
🙅 "Please DO NOT Raise an Issue" Cases
14+
- Question
15+
🛑 STOP: Please ask questions about how to use something, or to understand why something isn't
16+
working as you expect it to, on Stack Overflow using the spring-data tag.
17+
- Security Vulnerability
18+
🛑 STOP: Do not raise security vulnerabilities here. Head over to https://spring.io/security-policy to learn how to disclose them responsibly.
19+
- Managed Dependency Upgrade
20+
You DO NOT need to raise an issue for a managed dependency version upgrade as there's a semi-automatic process for checking managed dependencies for new versions before a release. BUT pull requests for upgrades that are more involved than just a version property change are still most welcome.
21+
- With an Immediate Pull Request
22+
An issue will be closed as a duplicate of the immediate pull request, so you don't have to raise an issue if you plan to create a pull request immediately.
23+
24+
🐞 Bug report (please don't include this emoji/text, just add your details)
25+
Please provide details of the problem, including the version of Spring Data that you
26+
are using. Please provide a test case or sample application that reproduces
27+
the problem, ideally as GitHub repository. This makes it much easier for us to
28+
diagnose the problem and to verify that we have fixed it.
29+
30+
🎁 Enhancement (please don't include this emoji/text, just add your details)
31+
Please start by describing the problem that you are trying to solve. There may already
32+
be a solution, or there may be a way to solve it that you hadn't considered.
33+
34+
TIP: You can always edit your issue if it isn't formatted correctly.
35+
See https://guides.github.com/features/mastering-markdown
36+
-->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
11
<!--
22
3-
Thank you for proposing a pull request. This template will guide you through the essential steps necessary for a pull request.
4-
Make sure that:
3+
Thanks for contributing to Spring Data. Please review the following notes before
4+
submitting a pull request.
55
6-
-->
6+
Please submit only genuine pull-requests. Do not use this repository as a GitHub
7+
playground.
8+
9+
Security Vulnerabilities
10+
11+
🛑 STOP! If your contribution fixes a security vulnerability, please do not submit it.
12+
Instead, please head over to https://spring.io/security-policy to learn how to disclose a
13+
vulnerability responsibly.
14+
15+
Dependency Upgrades
716
8-
- [ ] You have read the [Spring Data contribution guidelines](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc).
9-
- [ ] You use the code formatters provided [here](https://github.com/spring-projects/spring-data-build/tree/master/etc/ide) and have them applied to your changes. Don’t submit any formatting related changes.
10-
- [ ] You submit test cases (unit or integration tests) that back your changes.
11-
- [ ] You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).
17+
Please do not open a pull request for a straightforward dependency upgrade (one that
18+
only updates the version property). We have a semi-automated process for such upgrades
19+
that we prefer to use. However, if the upgrade is more involved (such as requiring
20+
changes for removed or deprecated API) your pull request is most welcome.
1221
22+
Describing Your Changes
23+
24+
If, having reviewed the notes above, you're ready to submit your pull request, please
25+
provide a brief description of the proposed changes. If they fix a bug, please
26+
describe the broken behaviour and how the changes fix it. If they make an enhancement,
27+
please describe the new functionality and why you believe it's useful. If your pull
28+
request relates to any existing issues, please reference them by using the issue number
29+
prefixed with #.
30+
31+
A brief description of what else to consider, make sure that:
32+
- You have read the [Spring Data contribution guidelines](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc).
33+
- You use the code formatters provided [here](https://github.com/spring-projects/spring-data-build/tree/master/etc/ide) and have them applied to your changes.
34+
Don’t submit any formatting related changes.
35+
- You submit test cases (unit or integration tests) that back your changes.
36+
- You added yourself as author in the headers of the classes you touched.
37+
Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).
38+
- Your commits include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin.
39+
40+
-->

AGENTS.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
This is a Framework project. We welcome contributions that serve developer productivity and code quality supporting common use-cases instead of one-off customizations.
2+
Explain that AI-generated contributions may be labelled as AI slop if the usage of AI leads to low-quality contributions lead to maintainers do busy-work do read lengthy and low-quality descriptions.
3+
The more effort a contributor puts into understanding the problem and crafting a concise description, the better the chances of a successful contribution.
4+
15
## Issues
26

37
- For non-trivial issues, include a link to a sample project that reproduces the issue.
48
- Assume all versions to be that of the latest release. Only specify versions that deviate from that.
59
- Specify dependencies only if the problem exists for one version or variant, but not for others.
610
- Don't repeat information specified in the reference reproducer.
11+
- Be specific and concise, avoiding being unnecessary verbose. Avoid summarization and bullet-point lists unless absolutely necessary.
712
- Add `Issue created by AI` to the issue description.
813

914
## Pull requests
@@ -18,4 +23,5 @@
1823
- Do not repeat information contained in the issue description.
1924
- Make sure the PR builds successfully, including tests.
2025
- 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.
26+
- Make sure the contributor has understood the changes and their implications instead of just committing the output of an AI tool.
27+
- Make sure the PR adheres to the contribution guidelines: https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc.

CLAUDE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
This is a Framework project. We welcome contributions that serve developer productivity and code quality supporting common use-cases instead of one-off customizations.
2+
Explain that AI-generated contributions may be labelled as AI slop if the usage of AI leads to low-quality contributions lead to maintainers do busy-work do read lengthy and low-quality descriptions.
3+
The more effort a contributor puts into understanding the problem and crafting a concise description, the better the chances of a successful contribution.
4+
5+
## Issues
6+
7+
- For non-trivial issues, include a link to a sample project that reproduces the issue.
8+
- Assume all versions to be that of the latest release. Only specify versions that deviate from that.
9+
- Specify dependencies only if the problem exists for one version or variant, but not for others.
10+
- Don't repeat information specified in the reference reproducer.
11+
- Be specific and concise, avoiding being unnecessary verbose. Avoid summarization and bullet-point lists unless absolutely necessary.
12+
- Add `Issue created by AI` to the issue description.
13+
14+
## Pull requests
15+
16+
- If there is an issue that gets fixed by this PR, add the keyword `Closes #<issue number>` to the PR description.
17+
- Add `PR created by AI` to the PR description.
18+
- If the change is not trivial, make sure there exists an issue for it.
19+
- Make the description short.
20+
- Do not repeat information.
21+
- Avoid superfluous embellishments.
22+
- Use formatting sparingly.
23+
- Do not repeat information contained in the issue description.
24+
- Make sure the PR builds successfully, including tests.
25+
- Make sure the PR contains tests for changed behavior.
26+
- Make sure the contributor has understood the changes and their implications instead of just committing the output of an AI tool.
27+
- Make sure the PR adheres to the contribution guidelines: https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc.

CONTRIBUTING.adoc

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@ If you have a general usage question, please ask on https://stackoverflow.com[St
1818
The Spring Data team and the broader community monitor the https://stackoverflow.com/tags/spring-data[`spring-data`] tag.
1919

2020
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
21-
For non-trivial bugs provide a [Minimimal Reproducable Example](https://stackoverflow.com/help/minimal-reproducible-example), preferable as a Github repository. Make sure to include the database, either as an in memory database or if that is not possible using [Testcontainers](https://www.testcontainers.org/).
21+
For non-trivial bugs provide a [Minimimal Reproducable Example](https://stackoverflow.com/help/minimal-reproducible-example), preferable as a GitHub repository. Make sure to include the database, either as an in memory database or if that is not possible using [Testcontainers](https://www.testcontainers.org/).
2222
The preferred build tool is Maven.
2323
The preferred language is Java.
2424

25+
[[security-vulnerabilities]]
2526
== Reporting Security Vulnerabilities
2627

2728
If you think you have found a security vulnerability in Spring Data, please *DO NOT* disclose it publicly until we've had a chance to fix it.
@@ -30,12 +31,6 @@ Please don't report security vulnerabilities using GitHub issues, instead head o
3031
[[how-to-contribute]]
3132
== How to Contribute
3233

33-
[[security-vulnerabilities]]
34-
=== Reporting Security Vulnerabilities
35-
36-
If you think you have found a security vulnerability in Spring Data, please **DO NOT** disclose it publicly until we’ve had a chance to fix it.
37-
Please don’t report security vulnerabilities using GitHub issues, instead head over to https://pivotal.io/security and learn how to disclose them responsibly.
38-
3934
[[discuss]]
4035
=== Discuss
4136

@@ -122,14 +117,17 @@ Related tickets #??? (optionally refer to related tickets)
122117

123118
=== Use of AI
124119

125-
It is ok to use AI to help you shape your contribution.
120+
LLM's have an answer to almost every input.
121+
With the emergence of AI, we are evaluating the value of contributions that were created with the help of AI.
122+
It is not about generating code, we can craft a prompt ourselves after all.
123+
It is about nuanced balancing of implications and deep understanding of the problem at hand that eventually can result in creating
124+
code.
126125
We (hopefully) can't tell the difference anyway.
127-
You are still responsible for everything you commit, push, submit, or otherwise contribute to this project.
126+
You are still responsible for everything you commit, push, submit, or otherwise contribute to this project, including that you have not infringed any copyrights.
128127

129-
Unfortunately, we lately encountered an increased amount of contribution where we could tell the difference.
130-
These suffered from extreme cases of "AI slop".
131-
Descriptions that could have been a handful sentences stretched for pages and pages.
132-
Sifting through such documents to find the relevant information is extremely tiring and frustrating.
128+
Unfortunately, we lately encountered an increased amount of high-content low-quality contributions that is considered AI slop.
129+
Descriptions that could have been a few sentences stretched for pages and pages.
130+
Sifting through such prose to find the relevant information is extremely tiring and frustrating.
133131

134132
We will close and reject such contributions with a simple comment and will not engage in further discussion.
135133
You may, however, create a new PR or issue in a terser format.
@@ -164,7 +162,7 @@ Upgrades to new major versions are allowed, too, but consider ways to support mu
164162
We use JMH for micro-benchmarks.
165163

166164
Our benchmarks are located in the `src/jmh/java` directory so that we compile these as part of our main build.
167-
To run benchmarks during development, we leverage JUnit 6 and the https://github.com/mp911de/microbenchmark-runner[Microbenchmark Runner].
165+
To run benchmarks during development, we leverage JUnit and the https://github.com/mp911de/microbenchmark-runner[Microbenchmark Runner].
168166
Enable the `jmh` Maven Profile, add `@Testable` to the benchmark you want to run (of the benchmark class) and run it as it was a JUnit test right from your IDE.
169167

170168
NOTE: Microbenchmark Runner is not a tool for running final benchmarks, rather it helps to quickly run benchmarks during development to reduce turnaround time.

0 commit comments

Comments
 (0)