Skip to content

Commit 4e07b33

Browse files
committed
Add templates for issues and pull requests
1 parent 999ef54 commit 4e07b33

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Thank you for taking time to open this issue!
2+
You might have already read the [README file][1] and the [Contributor Guide][2], but as a reminder, please check the following:
3+
4+
### Asking questions
5+
6+
If you have a question, please use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) and tag your question
7+
with `spring-batch`. We would like to keep the issue tracker exclusively for bug reports and feature requests.
8+
9+
### Reporting bugs
10+
11+
* Search Github issues first, and create an issue only if necessary (there might be already a duplicate issue)
12+
* Provide as much details as possible: Spring Batch version, Java version, which database you use if any, etc
13+
* If the bug is trivial, just go ahead and create the issue. Otherwise, please provide a failing unit test or a [minimal complete example][3] that reproduces the issue.
14+
15+
### Requesting features
16+
17+
* Search Github issues first, and create an issue only if necessary (the feature might have already been requested, but rejected)
18+
* Explain the reason why you need this feature (aka why it is not possible to implement the desired functionality with the current version)
19+
* Add a code example to explain what you think the feature should look like. This is optional, but it would help up understand your expectations.
20+
21+
Thank you upfront!
22+
23+
[1]: https://github.com/spring-projects/spring-batch/blob/master/README.md
24+
[2]: https://github.com/spring-projects/spring-batch/blob/master/CONTRIBUTING.md
25+
[3]: https://stackoverflow.com/help/minimal-reproducible-example

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Thank you for taking time to contribute this pull request!
2+
You might have already read the [contributor guide][1], but as a reminder, please make sure to:
3+
4+
* Sign the [contributor license agreement](https://cla.pivotal.io/sign/spring)
5+
* Rebase your changes on the latest `master` branch and squash your commits
6+
* Add/Update unit tests as needed
7+
* Run a build and make sure all tests pass prior to submission
8+
9+
For more details, please check the [contributor guide][1].
10+
Thank you upfront!
11+
12+
[1]: https://github.com/spring-projects/spring-batch/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)