Commit 0bff6c4b authored by Phillip Webb's avatar Phillip Webb

Merge branch '1.1.x'

parents a641f0c7 9059c757
= Contributing to Spring Boot = Contributing to Spring Boot
Spring Boot is released under the non-restrictive Apache 2.0 license. If you would like Spring Boot is released under the Apache 2.0 license. If you would like to contribute
to contribute something, or simply want to hack on the code this document should help something, or simply want to hack on the code this document should help you get started.
you get started.
== Sign the Contributor License Agreement == Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the Before we accept a non-trivial patch or pull request we will need you to sign the
...@@ -12,6 +13,8 @@ repository, but it does mean that we can accept your contributions, and you will ...@@ -12,6 +13,8 @@ repository, but it does mean that we can accept your contributions, and you will
author credit if we do. Active contributors might be asked to join the core team, and author credit if we do. Active contributors might be asked to join the core team, and
given the ability to merge pull requests. given the ability to merge pull requests.
== Code Conventions and Housekeeping == Code Conventions and Housekeeping
None of these is essential for a pull request, but they will all help. They can also be 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. added after the original pull request but before a merge.
...@@ -37,6 +40,8 @@ added after the original pull request but before a merge. ...@@ -37,6 +40,8 @@ added after the original pull request but before a merge.
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit 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). message (where XXXX is the issue number).
== Working with the code == Working with the code
If you don't have an IDE preference we would recommend that you use If you don't have an IDE preference we would recommend that you use
http://www.springsource.com/developer/sts[Spring Tools Suite] or http://www.springsource.com/developer/sts[Spring Tools Suite] or
...@@ -44,10 +49,14 @@ http://eclipse.org[Eclipse] when working with the code. We use the ...@@ -44,10 +49,14 @@ http://eclipse.org[Eclipse] when working with the code. We use the
http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools
should also work without issue. should also work without issue.
=== Building from source === Building from source
To build the source you will need to install To build the source you will need to install
http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7. http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7.
==== Default build ==== Default build
The project can be built from the root directory using the standard maven command: The project can be built from the root directory using the standard maven command:
...@@ -67,6 +76,8 @@ to submit a pull request: ...@@ -67,6 +76,8 @@ to submit a pull request:
$ mvn clean install -DskipTests $ mvn clean install -DskipTests
---- ----
==== Full Build ==== Full Build
Multi-module Maven builds cannot directly include maven plugins that are part of the Multi-module Maven builds cannot directly include maven plugins that are part of the
reactor unless they have previously been built. Unfortunately this restriction causes reactor unless they have previously been built. Unfortunately this restriction causes
...@@ -109,6 +120,8 @@ to Maven by setting a `MAVEN_OPTS` environment variable with the value ...@@ -109,6 +120,8 @@ to Maven by setting a `MAVEN_OPTS` environment variable with the value
`-Xmx512m -XX:MaxPermSize=128m`. We generate more artifacts when running the full build `-Xmx512m -XX:MaxPermSize=128m`. We generate more artifacts when running the full build
(such as Javadoc jars), so you may find the process a little slower than the standard build. (such as Javadoc jars), so you may find the process a little slower than the standard build.
=== Importing into eclipse with m2eclipse === Importing into eclipse with m2eclipse
We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
...@@ -132,6 +145,8 @@ With the requisite eclipse plugins installed you can select ...@@ -132,6 +145,8 @@ With the requisite eclipse plugins installed you can select
`import existing maven projects` from the `file` menu to import the code. You will `import existing maven projects` from the `file` menu to import the code. You will
need to import the root `spring-boot` pom and the `spring-boot-samples` pom separately. need to import the root `spring-boot` pom and the `spring-boot-samples` pom separately.
=== Importing into eclipse without m2eclipse === Importing into eclipse without m2eclipse
If you prefer not to use m2eclipse you can generate eclipse project metadata using the If you prefer not to use m2eclipse you can generate eclipse project metadata using the
following command: following command:
...@@ -144,9 +159,13 @@ following command: ...@@ -144,9 +159,13 @@ following command:
The generated eclipse projects can be imported by selecting `import existing projects` The generated eclipse projects can be imported by selecting `import existing projects`
from the `file` menu. from the `file` menu.
=== Importing into other IDEs === Importing into other IDEs
Maven is well supported by most Java IDEs. Refer to your vendor documentation. Maven is well supported by most Java IDEs. Refer to your vendor documentation.
== Integration tests == Integration tests
The sample application are used as integration tests during the build (when you The sample application are used as integration tests during the build (when you
`mvn install`). Due to the fact that they make use of the `spring-boot-maven-plugin` `mvn install`). Due to the fact that they make use of the `spring-boot-maven-plugin`
......
This diff is collapsed.
...@@ -190,6 +190,7 @@ Java samples are available in link:spring-boot-samples[spring-boot-samples] and ...@@ -190,6 +190,7 @@ Java samples are available in link:spring-boot-samples[spring-boot-samples] and
be built with maven and run by invoking `java -jar target/<sample>.jar`. be built with maven and run by invoking `java -jar target/<sample>.jar`.
== Guides == Guides
The http://spring.io/[spring.io] site contains several guides that show how to use Spring The http://spring.io/[spring.io] site contains several guides that show how to use Spring
Boot step-by-step: Boot step-by-step:
...@@ -202,3 +203,9 @@ Boot step-by-step: ...@@ -202,3 +203,9 @@ Boot step-by-step:
can be configured. can be configured.
* http://spring.io/guides/gs/convert-jar-to-war/[Converting a Spring Boot JAR Application * http://spring.io/guides/gs/convert-jar-to-war/[Converting a Spring Boot JAR Application
to a WAR] shows you how to run applications in a web server as a WAR file. to a WAR] shows you how to run applications in a web server as a WAR file.
== License
Spring Boot is Open Source software released under the
http://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment