37 lines
2.1 KiB
Plaintext
37 lines
2.1 KiB
Plaintext
= 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.
|
|
|
|
== Code of Conduct
|
|
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md
|
|
|
|
== Using GitHub issues
|
|
We use GitHub issues to track bugs and enhancements. If you have a general usage question
|
|
please ask on https://stackoverflow.com[Stack Overflow]. The Spring Tools team and the
|
|
broader community monitor the https://stackoverflow.com/tags/spring-tools[`spring-tools`]
|
|
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 https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring[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 https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[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).
|