Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 2.55 KB

CONTRIBUTING.adoc

File metadata and controls

52 lines (42 loc) · 2.55 KB

Contributing to Spring Web Services

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

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Using Github issues

We use Github issues to track bugs and enhancements. If you have a general usage question please ask on Stack Overflow. The Spring Web Services team and the broader community monitor the spring-ws tag.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Submitting a github-hosted sample project replicating the problem helps.

Include a Signed Off By Trailer

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. For additional details, please refer to the blog post Hello DCO, Goodbye CLA: Simplifying Contributions to Spring.

Code Conventions and Housekeeping

None of these are essential for a pull request, but they help. They can also be added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions.

  • 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.

  • Add the ASF license header comment to all new .java files (copy from existing files in the project)

  • Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).

  • Add some Javadocs.

  • A few unit tests would help a lot as well — someone has to do it.

  • If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project).

  • When writing a commit message please follow these conventions.

Building from source

This project includes the Gradle wrapper, meaning you don’t have to install any CLI tools to compile. Once you’ve cloned the project, it can be built from the root directory using the following command:

$ ./gradlew build