Skip to content

Commit 5c99ce1

Browse files
committed
Migrate documentation to one line per sentence
Closes gh-1483
1 parent 10f4a3b commit 5c99ce1

File tree

10 files changed

+1098
-426
lines changed

10 files changed

+1098
-426
lines changed

CONTRIBUTING.adoc

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,43 @@
11
= Contributing to Spring Web Services
22

3-
Spring Web Services is released under the Apache 2.0 license. If you would like to contribute
4-
something, or simply want to hack on the code this document should help you get started.
3+
Spring Web Services is released under the Apache 2.0 license.
4+
If you would like to contribute something, or simply want to hack on the code this document should help you get started.
55

66
== Code of Conduct
7-
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of
8-
conduct]. By participating, you are expected to uphold this code. Please report
9-
unacceptable behavior to [email protected].
107

11-
== Using Github issues
12-
We use Github issues to track bugs and enhancements. If you have a general usage question
13-
please ask on https://stackoverflow.com[Stack Overflow]. The Spring Web Services team and the
14-
broader community monitor the https://stackoverflow.com/tags/spring-ws[`spring-ws`]
15-
tag.
8+
This project adheres to the Contributor Covenant https://github.com/spring-projects/spring-ws?tab=coc-ov-file#contributor-code-of-conduct[code of conduct].
9+
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
1610

17-
If you are reporting a bug, please help to speed up problem diagnosis by providing as much
18-
information as possible. Submitting a github-hosted sample project replicating the problem helps.
11+
== Using GitHub issues
12+
13+
We use GitHub issues to track bugs and enhancements.
14+
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
15+
The Spring Web Services team and the broader community monitor the https://stackoverflow.com/tags/spring-ws[`spring-ws`] tag.
16+
17+
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
18+
Submitting a github-hosted sample project replicating the problem helps.
1919

2020
== Include a Signed Off By Trailer
2121

22-
All commits must include a __Signed-off-by__ trailer at the end of each commit message to
23-
indicate that the contributor agrees to the Developer Certificate of Origin.
24-
For additional details, please refer to the blog post
25-
https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring[Hello
26-
DCO, Goodbye CLA: Simplifying Contributions to Spring].
22+
All commits must 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.
23+
For additional details, please refer to the blog post https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring[Hello DCO, Goodbye CLA: Simplifying Contributions to Spring].
2724

2825
== Code Conventions and Housekeeping
29-
None of these are essential for a pull request, but they help. They can also be
30-
added after the original pull request but before a merge.
26+
27+
None of these are essential for a pull request, but they help.
28+
They can also be added after the original pull request but before a merge.
3129

3230
* Use the Spring Framework code format conventions.
33-
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
34-
`@author` tag identifying you, and preferably at least a paragraph on what the class is
35-
for.
36-
* Add the ASF license header comment to all new `.java` files (copy from existing files
37-
in the project)
38-
* Add yourself as an `@author` to the `.java` files that you modify substantially (more
39-
than cosmetic changes).
31+
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for.
32+
* Add the ASF license header comment to all new `.java` files (copy from existing files in the project)
33+
* Add yourself as an `@author` to the `.java` files that you modify substantially (more than cosmetic changes).
4034
* Add some Javadocs.
4135
* A few unit tests would help a lot as well -- someone has to do it.
42-
* If no-one else is using your branch, please rebase it against the current main (or
43-
other target branch in the main project).
36+
* If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project).
4437
* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions].
4538

4639
=== Building from source
40+
4741
This project includes the Gradle wrapper, meaning you don't have to install any CLI tools to compile.
4842
Once you've cloned the project, it can be built from the root directory using the following command:
4943

0 commit comments

Comments
 (0)