Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community Support
url: https://stackoverflow.com/tags/spring-data
about: Please ask and answer questions on StackOverflow with the tag `spring-data`.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: General issue
about: Bugs, enhancements, documentation, tasks.
title: ''
labels: ''
assignees: ''
---

<!--
Thanks for raising a Spring Data issue. Please take the time to review the following
categories as some of them do not apply here:

🙅 "Please DO NOT Raise an Issue" Cases
- Question
🛑 STOP: Please ask questions about how to use something, or to understand why something isn't
working as you expect it to, on Stack Overflow using the spring-data tag.
- Security Vulnerability
🛑 STOP: Do not raise security vulnerabilities here. Head over to https://spring.io/security-policy to learn how to disclose them responsibly.
- Managed Dependency Upgrade
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.
- With an Immediate Pull Request
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.

🐞 Bug report (please don't include this emoji/text, just add your details)
Please provide details of the problem, including the version of Spring Data that you
are using. Please provide a test case or sample application that reproduces
the problem, ideally as GitHub repository. This makes it much easier for us to
diagnose the problem and to verify that we have fixed it.

🎁 Enhancement (please don't include this emoji/text, just add your details)
Please start by describing the problem that you are trying to solve. There may already
be a solution, or there may be a way to solve it that you hadn't considered.

TIP: You can always edit your issue if it isn't formatted correctly.
See https://guides.github.com/features/mastering-markdown
-->
42 changes: 35 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
<!--

Thank you for proposing a pull request. This template will guide you through the essential steps necessary for a pull request.
Make sure that:
Thanks for contributing to Spring Data. Please review the following notes before
submitting a pull request.

-->
Please submit only genuine pull-requests. Do not use this repository as a GitHub
playground.

Security Vulnerabilities

🛑 STOP! If your contribution fixes a security vulnerability, please do not submit it.
Instead, please head over to https://spring.io/security-policy to learn how to disclose a
vulnerability responsibly.

Dependency Upgrades

- [ ] You have read the [Spring Data contribution guidelines](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc).
- [ ] 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.
- [ ] You submit test cases (unit or integration tests) that back your changes.
- [ ] 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).
Please do not open a pull request for a straightforward dependency upgrade (one that
only updates the version property). We have a semi-automated process for such upgrades
that we prefer to use. However, if the upgrade is more involved (such as requiring
changes for removed or deprecated API) your pull request is most welcome.

Describing Your Changes

If, having reviewed the notes above, you're ready to submit your pull request, please
provide a brief description of the proposed changes. If they fix a bug, please
describe the broken behaviour and how the changes fix it. If they make an enhancement,
please describe the new functionality and why you believe it's useful. If your pull
request relates to any existing issues, please reference them by using the issue number
prefixed with #.

A brief description of what else to consider, make sure that:
- You have read the [Spring Data contribution guidelines](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc).
- 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.
- You submit test cases (unit or integration tests) that back your changes.
- 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).
- 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.

-->
27 changes: 27 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This is a Framework project. We welcome contributions that serve developer productivity and code quality supporting common use-cases instead of one-off customizations.
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.
The more effort a contributor puts into understanding the problem and crafting a concise description, the better the chances of a successful contribution.

## Issues

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

## Pull requests

- If there is an issue that gets fixed by this PR, add the keyword `Closes #<issue number>` to the PR description.
- Add `PR created by AI` to the PR description.
- If the change is not trivial, make sure there exists an issue for it.
- Make the description short.
- Do not repeat information.
- Avoid superfluous embellishments.
- Use formatting sparingly.
- Do not repeat information contained in the issue description.
- Make sure the PR builds successfully, including tests.
- Make sure the PR contains tests for changed behavior.
- Make sure the contributor has understood the changes and their implications instead of just committing the output of an AI tool.
- Make sure the PR adheres to the contribution guidelines: https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc.
27 changes: 27 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This is a Framework project. We welcome contributions that serve developer productivity and code quality supporting common use-cases instead of one-off customizations.
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.
The more effort a contributor puts into understanding the problem and crafting a concise description, the better the chances of a successful contribution.

## Issues

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

## Pull requests

- If there is an issue that gets fixed by this PR, add the keyword `Closes #<issue number>` to the PR description.
- Add `PR created by AI` to the PR description.
- If the change is not trivial, make sure there exists an issue for it.
- Make the description short.
- Do not repeat information.
- Avoid superfluous embellishments.
- Use formatting sparingly.
- Do not repeat information contained in the issue description.
- Make sure the PR builds successfully, including tests.
- Make sure the PR contains tests for changed behavior.
- Make sure the contributor has understood the changes and their implications instead of just committing the output of an AI tool.
- Make sure the PR adheres to the contribution guidelines: https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc.
Loading
Loading