Skip to content

Commit f06772d

Browse files
committed
Update community files
1 parent 71e7dd5 commit f06772d

File tree

4 files changed

+54
-39
lines changed

4 files changed

+54
-39
lines changed

.github/ISSUE_TEMPLATE/miscellaneous.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,8 @@ assignees: ''
1010
For anything other than bug reports and feature requests (performance, refactoring, etc),
1111
just go ahead and file the issue. Please provide as many details as possible.
1212

13-
If you have a question, please use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) and tag your question
14-
with `spring-batch`. We would like to keep the issue tracker exclusively for bug reports and feature requests.
13+
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
14+
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
15+
16+
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
17+
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.

CONTRIBUTING.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,18 @@ Please see our [Security policy](https://github.com/spring-projects/spring-batch
1717

1818
## Reporting issues
1919

20-
Is there already an issue that addresses your concern? Please do a quick search in [Github issues][] to see if you can find something similar.
20+
Before opening an issue, please do a quick search in [Github issues][] to see if you can find something similar.
2121
If not, please read the [Issue Reporting](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md) section for more details
2222
about how to report issues.
2323

2424
## Contributing through Pull Requests on GitHub
2525

26-
Not sure what a *pull request* is, or how to submit one? Take a look at the excellent [GitHub help documentation][] first.
26+
Not sure what a *pull request* is, or how to submit one? Take a look at the excellent [GitHub help documentation][] first.
2727
Please create a new issue *before* submitting a pull request unless the change is truly trivial, e.g. typo fixes, removing compiler warnings, etc.
2828

2929
### Sign the contributor license agreement
3030

31-
If you have not previously done so, please fill out and
32-
submit the [Contributor License Agreement](https://cla.pivotal.io/sign/spring).
31+
If you have not previously done so, please fill out and submit the [Contributor License Agreement](https://cla.pivotal.io/sign/spring).
3332

3433
### Fork the Repository
3534

README.md

+41-31
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,47 @@ Spring Batch is a lightweight, comprehensive batch framework designed to enable
66

77
If you are looking for a runtime orchestration tool for your Batch applications, or need a management console to view current and historic executions, take a look at [Spring Cloud Data Flow](https://cloud.spring.io/spring-cloud-dataflow/). It is an orchestration tool for deploying and executing data integration based microservices including Spring Batch applications.
88

9-
## Code of Conduct
9+
# Getting Started
1010

11-
Please see our [code of conduct](https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md).
11+
## Guide
12+
13+
This is the quickest way to get started with a new Spring Batch project based on Spring Boot. You find the Getting Started Guide here: [Creating a Batch Service](https://spring.io/guides/gs/batch-processing/).
14+
15+
## Samples
16+
17+
You can find several samples to try out here: [Spring Batch Samples](https://github.com/spring-projects/spring-batch/tree/main/spring-batch-samples).
18+
19+
# Getting Help
20+
21+
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
22+
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
23+
24+
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
25+
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.
26+
27+
# Reporting issues
28+
29+
Spring Batch uses [GitHub Issues](https://github.com/spring-projects/spring-batch/issues) to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
30+
31+
* Before you open an issue, please search the issue tracker to see if someone has already reported the problem. If the issue doesn't already exist, create a new issue.
32+
* Please provide as much information as possible in the issue report by following the [Issue Reporting Template](https://github.com/spring-projects/spring-batch/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
33+
* If you need to paste code or include a stack trace, please use Markdown escapes (```) before and after your text.
1234

13-
## Reporting Security Vulnerabilities
35+
For non trivial bugs, please create a test case or a project that replicates the problem and attach it to the issue, as detailed in the [Issue Reporting Guidelines](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md).
36+
37+
# Reporting Security Vulnerabilities
1438

1539
Please see our [Security policy](https://github.com/spring-projects/spring-batch/security/policy).
1640

1741
# Building from Source
1842

43+
## Using the Command Line
44+
1945
Clone the git repository using the URL on the Github home page:
2046

2147
$ git clone [email protected]:spring-projects/spring-batch.git
2248
$ cd spring-batch
2349

24-
## Command Line
25-
2650
Maven is the build tool used for Spring Batch. You can build the project with the following command:
2751

2852
$ ./mvnw package
@@ -43,9 +67,6 @@ $ ../mvnw site
4367

4468
The reference documentation can be found in `spring-batch-docs/target`.
4569

46-
## Spring Tool Suite (STS)
47-
In STS (or any Eclipse distro or other IDE with Maven support), import the module directories as existing projects. They should compile and the tests should run with no additional steps.
48-
4970
## Using Docker
5071

5172
If you want to build the project in a Docker container, you can proceed as follows:
@@ -67,33 +88,22 @@ $> docker run -it maven:3-openjdk-17 bash
6788
#> ./mvnw package
6889
```
6990

70-
# Getting Started Using Spring Boot
71-
This is the quickest way to get started with a new Spring Batch project. You find the Getting Started Guide for Spring
72-
Batch on Spring.io: [Creating a Batch Service](https://spring.io/guides/gs/batch-processing/)
73-
74-
# Getting Started Using Spring Tool Suite (STS)
91+
# Contributing to Spring Batch
7592

76-
It requires an internet connection for download, and access to a Maven repository (remote or local).
93+
We welcome contributions in any kind! Here are some ways for you to contribute to the project:
7794

78-
* Download STS version 3.4.* (or better) from the [Spring website](https://spring.io/tools). STS is a free Eclipse bundle with many features useful for Spring developers.
79-
* Go to `File->New->Spring Template Project` from the menu bar (in the Spring perspective).
80-
* The wizard has a drop down with a list of template projects. One of them is a "Simple Spring Batch Project". Select it and follow the wizard.
81-
* A project is created with all dependencies and a simple input/output job configuration. It can be run using a unit test, or on the command line (see instructions in the pom.xml).
95+
* Get involved with the Spring Batch community on [Twitter](https://twitter.com/springbatch), [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions) and [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) by responding to questions and joining the debate.
96+
* Create [issues](https://github.com/spring-projects/spring-batch/issues) for bugs and new features or comment and vote on the ones that you are interested in.
97+
* Help us reproduce issues marked with [status: need-help-to-reproduce](https://github.com/spring-projects/spring-batch/labels/status%3A%20need-help-to-reproduce) by following the [Issue Reporting Guidelines](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md).
98+
* Github is for social coding: if you want to write code, we encourage contributions through pull requests. If you want to contribute code this way, please familiarize yourself with the process outlined here: [Contributor Guidelines](https://github.com/spring-projects/spring-batch/blob/main/CONTRIBUTING.md).
99+
* Watch for Spring Batch related articles on [spring.io](https://spring.io).
82100

83-
# Getting Help
101+
Before we accept pull requests, we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
84102

85-
Read the main project [website](https://projects.spring.io/spring-batch/) and the [User Guide](https://docs.spring.io/spring-batch/docs/current/reference/).
86-
Look at the source code and the Javadocs.
87-
For more detailed questions, use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
88-
If you are new to Spring as well as to Spring Batch, look for information about [Spring projects](https://spring.io/projects).
103+
# Code of Conduct
89104

90-
# Contributing to Spring Batch
91-
92-
Here are some ways for you to get involved in the community:
105+
Please see our [code of conduct](https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md).
93106

94-
* Get involved with the Spring Batch community on [Twitter](https://twitter.com/springbatch) and [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) by responding to questions and joining the debate.
95-
* Create [issues](https://github.com/spring-projects/spring-batch/issues) for bugs and new features and comment and vote on the ones that you are interested in.
96-
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, please familiarize yourself with the process outlined for contributing to Spring projects here: [Contributor Guidelines](https://github.com/spring-projects/spring-batch/blob/main/CONTRIBUTING.md).
97-
* Watch for upcoming articles on Spring by [subscribing](feed://assets.spring.io/drupal/node/feed.xml) to [spring.io](https://spring.io).
107+
# License
98108

99-
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
109+
Spring Batch is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).

SUPPORT.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1-
If you have a question, please use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) and tag your question
2-
with `spring-batch`. We would like to keep the issue tracker exclusively for bug reports and feature requests.
1+
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
2+
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
3+
4+
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
5+
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.

0 commit comments

Comments
 (0)