From 6c0264bc89b6f65ebcd82180c71e4db3f59bc0c4 Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Mon, 1 Feb 2016 20:00:41 -0700 Subject: [PATCH] Update readme to include code of conduct. See https://github.com/spring-cloud/spring-cloud-build/issues/26 --- README.adoc | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.adoc b/README.adoc index 84db55b8..e9272ed1 100644 --- a/README.adoc +++ b/README.adoc @@ -85,10 +85,8 @@ https://github.com/spring-cloud-samples/scripts[scripts demo repository] for specific instructions about the common cases of mongo, rabbit and redis. -NOTE: migration to the Maven wrapper (`./mvnw`) is underway. If you -find a project that doesn't have it yet, raise an issue to get it -added, and build with the command from `.travis.yml` (usually -`mvn install -s .settings.xml`). +NOTE: If all else fails, build with the command from `.travis.yml` (usually +`./mvnw install`). === Documentation @@ -116,7 +114,7 @@ marketplace". Unfortunately m2e does not yet support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the `.settings.xml` file for the projects. If you do not do this you -may see errors many different errors related to the POMs in the +may see many different errors related to the POMs in the projects. Open your Eclipse preferences, expand the Maven preferences, and select User Settings. In the User Settings field click Browse and navigate to the Spring Cloud project you imported @@ -156,6 +154,18 @@ The method getId() is undefined for the type ProxyRouteLocator.ProxyRouteSpec The method getLocation() is undefined for the type ProxyRouteLocator.ProxyRouteSpec PreDecorationFilter.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/zuul/filters/pre line 55 Java Problem ---- +==== Importing into Intellij +Spring Cloud projects use annotation processing, particularly Lombok, which requires configuration +or you will encounter compile problems. It also needs a specific version of maven and a profile +enabled. Intellij 14.1+ requires some configuration to ensure these are setup properly. + + 1. Click Preferences, Plugins. *Ensure Lombok is installed* + 2. Click New, Project from Existing Sources, choose your spring-cloud-sleuth directory + 3. Choose Maven, and select Environment Settings. *Ensure you are using Maven 3.3.3* + 4. In the next screen, *Select the profile `spring`* click Next until Finish. + 5. Click Preferences, "Build, Execution, Deployment", Compiler, Annotation Processors. *Click Enable Annotation Processing* + 6. Click Build, Rebuild Project, and you are ready to go! + ==== Importing into other IDEs Maven is well supported by most Java IDEs. Refer to you vendor documentation. @@ -176,6 +186,11 @@ 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 given the ability to merge pull requests. +=== Code of Conduct +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of +conduct]. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io. + === 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. @@ -183,7 +198,7 @@ added after the original pull request but before a merge. * Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the - https://github.com/spring-cloud/build/tree/master/eclipse-coding-conventions.xml[Spring + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring Cloud Build] project. If using IntelliJ, you can use the http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file.