mirror of
https://gitee.com/dcren/initializr.git
synced 2025-04-05 17:38:06 +08:00
37 lines
2.0 KiB
Plaintext
37 lines
2.0 KiB
Plaintext
|
= Contributing to Spring Initializr
|
||
|
|
|
||
|
|
Spring Initializr 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.
|
||
|
|
|
||
|
|
|
||
|
|
== Sign the Contributor License Agreement
|
||
|
|
Before we accept a non-trivial patch or pull request we will need you to sign the
|
||
|
|
https://support.springsource.com/spring_committer_signup[contributor's agreement].
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
== 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.
|
||
|
|
|
||
|
|
* Use the https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-Code-Style[Spring Framework code format conventions].
|
||
|
|
* Make sure all new `.groovy` 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 `.groovy` files (copy from existing files
|
||
|
|
in the project)
|
||
|
|
* Add yourself as an `@author` to the .groovy files that you modify substantially (more
|
||
|
|
than cosmetic changes).
|
||
|
|
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
|
||
|
|
* 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 http://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).
|
||
|
|
|
||
|
|
|