Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 2.06 KB

CONTRIBUTING.adoc

File metadata and controls

36 lines (30 loc) · 2.06 KB

Contributing to Spring Tools

Spring Tools is released under the Eclipse Public License 1.0 (EPL). If you would like to contribute something, or simply want to hack on the code this document should help you get started.

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 Tools team and the broader community monitor the spring-tools-4 tag.

Developer Certificate of Origin

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 is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Make sure all new source files to have a simple class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.

  • Add the EPL license header comment to all new source files (copy from existing files in the project)

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

  • Add some docs.

  • 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 master (or other target branch in the main project).

  • When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number).