Skip to content

Commit 2c77021

Browse files
Merge branch '2.4.x'
Closes spring-projectsgh-26334
2 parents b976483 + 65cb654 commit 2c77021

File tree

1 file changed

+1
-121
lines changed

1 file changed

+1
-121
lines changed

CONTRIBUTING.adoc

+1-121
Original file line numberDiff line numberDiff line change
@@ -55,124 +55,4 @@ added after the original pull request but before a merge.
5555

5656

5757
== Working with the Code
58-
If you don't have an IDE preference we would recommend that you use https://spring.io/tools[Spring Tool Suite] or https://eclipse.org[Eclipse] when working with the code.
59-
We use the https://projects.eclipse.org/projects/tools.buildship[Buildship] Eclipse plugin for Gradle support.
60-
Other IDEs and tools should also work without issue.
61-
62-
63-
64-
=== Building from Source
65-
Spring Boot source can be built from the command line using https://gradle.org[Gradle] on JDK 1.8 or above.
66-
We include https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle's wrapper scripts] (`./gradlew` or `gradlew.bat`) that you can run rather than needing to install Gradle locally.
67-
68-
The project can be built from the root directory using the standard Gradle command:
69-
70-
[indent=0]
71-
----
72-
$ ./gradlew build
73-
----
74-
75-
76-
77-
== Updating the Reference Documentation
78-
The reference documentation is stored in this repository, see `spring-boot-project/spring-boot-docs/src/docs/asciidoc`.
79-
We use https://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoc] and you can build the documentation locally using this command:
80-
81-
[indent=0]
82-
----
83-
$ ./gradlew spring-boot-project:spring-boot-docs:asciidoc
84-
----
85-
86-
NOTE: The generated HTML documentation is available from `spring-boot-project/spring-boot-docs/build/docs/asciidoc/`.
87-
88-
89-
90-
=== Importing into Eclipse
91-
You can import the Spring Boot code into any Eclipse 2019-12-based distribution.
92-
The easiest way to setup a new environment is to use the Eclipse Installer with the provided `spring-boot-project.setup` file (in the `/eclipse` folder).
93-
94-
95-
96-
==== Using the Eclipse Installer
97-
Spring Boot includes a `.setup` files which can be used with the Eclipse Installer to provision a new environment.
98-
To use the installer:
99-
100-
* Download and run the latest https://download.eclipse.org/justj/?file=oomph/products/latest[Eclipse Installer] (must be 1.19.0 or above).
101-
* Switch to "Advanced Mode" using the drop down menu on the right.
102-
* Select "`Eclipse IDE for Java Developers`" under "`Eclipse.org`" as the product to install, `2020-12` as the product version, and click "`next`".
103-
* For the "`Project`" click on "`+`" to add a new setup file.
104-
Select "`Github Projects`" and browse for `<checkout>/eclipse/spring-boot-project.setup` from your locally cloned copy of the source code.
105-
Click "`OK`" to add the setup file to the list.
106-
* Double-click on "`Spring Boot`" from the project list to add it to the list that will be provisioned then click "`Next`".
107-
* Click show all variables and make sure that "`Checkout Location`" points to the locally cloned source code that you selected earlier.
108-
You might also want to pick a different install location here.
109-
* Click "`Finish`" to install the software.
110-
111-
Once complete you should find that a local workspace has been provisioned complete with all required Eclipse plugins.
112-
Projects will be grouped into working-sets to make the code easier to navigate.
113-
114-
TIP: If you see import errors with `com.sun` packages make sure you have setup a valid `JavaSE-1.8` environment. From preferences select "`Java`", "`Installed JREs`", "`Execution Environments`" and make sure "`JavaSE-1.8`" points to a Java 1.8 install (we use AdoptOpenJDK on our CI).
115-
116-
117-
118-
==== Manual Installation with Buildship
119-
If you prefer to install Eclipse yourself you should use the https://projects.eclipse.org/projects/tools.buildship[Buildship] Eclipse plugin.
120-
If you don't already have Buildship installed it is available from the "`Eclipse marketplace`".
121-
122-
Spring Boot includes project specific source formatting settings, in order to have these work with Buildship, we provide an additional Eclipse plugin that you can install.
123-
124-
125-
126-
===== Install the Spring Formatter plugin
127-
* Select "`Help`" -> "`Install New Software`".
128-
* Add `https://repo.spring.io/javaformat-eclipse-update-site/` as a site.
129-
* Install "Spring Java Format".
130-
131-
NOTE: The plugin is optional.
132-
Projects can be imported without the plugins, your code changes just won't be automatically formatted.
133-
134-
With the requisite Eclipse plugins installed you can select `Gradle -> Existing Gradle project` from the `File -> Import...` menu to import the code.
135-
136-
137-
138-
=== Importing into IntelliJ IDEA
139-
If you have performed a checkout of this repository already, use "`File`" -> "`Open`" and then select the root `build.gradle` file to import the code.
140-
141-
Alternatively, you can let IntelliJ IDEA checkout the code for you. Use "`File`" -> "`New`" -> "`Project from Version Control`" and `https://github.com/spring-projects/spring-boot` for the URL.
142-
Once the checkout has completed, a pop-up will suggest to open the project.
143-
144-
145-
146-
==== Install the Spring Formatter plugin
147-
If you haven't done so, install the formatter plugin so that proper formatting rules are applied automatically when you reformat code in the IDE.
148-
149-
* Download the latest https://search.maven.org/search?q=g:io.spring.javaformat%20AND%20a:spring-javaformat-intellij-idea-plugin[IntelliJ IDEA plugin].
150-
* Select "`IntelliJ IDEA`" -> "`Preferences`".
151-
* Select "`Plugins`".
152-
* Select the wheel and "`Install Plugin from Disk...`".
153-
* Select the jar file you've downloaded.
154-
155-
156-
157-
==== Import additional code style
158-
The formatter does not cover all rules (such as order of imports) and an additional file needs to be added.
159-
160-
* Select "`IntelliJ IDEA`" -> "`Preferences`".
161-
* Select "`Editor`" -> "`Code Style`".
162-
* Select the wheel and "`Import Scheme`" -> "`IntelliJ IDEA code style XML`".
163-
* Select `idea/codeStyleConfig.xml` from this repository.
164-
165-
166-
167-
=== Importing into Other IDEs
168-
Gradle is well supported by most Java IDEs. Refer to your vendor documentation.
169-
170-
171-
172-
== Cloning the git repository on Windows
173-
Some files in the git repository may exceed the Windows maximum file path (260 characters), depending on where you clone the repository.
174-
If you get `Filename too long` errors, set the `core.longPaths=true` git option:
175-
176-
```
177-
git clone -c core.longPaths=true https://github.com/spring-projects/spring-boot
178-
```
58+
For information on editing, building, and testing the code, see the https://github.com/spring-projects/spring-boot/wiki/Working-with-the-Code[Working with the Code] page on the project wiki.

0 commit comments

Comments
 (0)