You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.adoc
+6
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,14 @@ Spring Boot is released under the Apache 2.0 license. If you would like to contr
5
5
6
6
7
7
== Code of Conduct
8
+
8
9
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
9
10
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
10
11
11
12
12
13
13
14
== Using GitHub Issues
15
+
14
16
We use GitHub issues to track bugs and enhancements.
15
17
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
16
18
The Spring Boot team and the broader community monitor the https://stackoverflow.com/tags/spring-boot[`spring-boot`] tag.
@@ -21,19 +23,22 @@ Ideally, that would include a small sample project that reproduces the problem.
21
23
22
24
23
25
== Reporting Security Vulnerabilities
26
+
24
27
If you think you have found a security vulnerability in Spring Boot please *DO NOT* disclose it publicly until we've had a chance to fix it.
25
28
Please don't report security vulnerabilities using GitHub issues, instead head over to https://spring.io/security-policy and learn how to disclose them responsibly.
26
29
27
30
28
31
29
32
== Sign the Contributor License Agreement
33
+
30
34
Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement].
31
35
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.
32
36
Active contributors might be asked to join the core team, and given the ability to merge pull requests.
33
37
34
38
35
39
36
40
== Code Conventions and Housekeeping
41
+
37
42
None of these is essential for a pull request, but they will all help. They can also be
38
43
added after the original pull request but before a merge.
39
44
@@ -55,4 +60,5 @@ added after the original pull request but before a merge.
55
60
56
61
57
62
== Working with the Code
63
+
58
64
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.
Copy file name to clipboardexpand all lines: README.adoc
+35-19
Original file line number
Diff line number
Diff line change
@@ -19,35 +19,37 @@ Our primary goals are:
19
19
20
20
21
21
== Installation and Getting Started
22
+
22
23
The {docs}/html/[reference documentation] includes detailed {docs}/html/getting-started.html#getting-started-installing-spring-boot[installation instructions] as well as a comprehensive {docs}/html/getting-started.html#getting-started-first-application[``getting started``] guide.
23
24
24
25
Here is a quick teaser of a complete Spring Boot application in Java:
25
26
26
-
[source,java,indent=0]
27
+
[source,java]
27
28
----
28
-
import org.springframework.boot.*;
29
-
import org.springframework.boot.autoconfigure.*;
30
-
import org.springframework.web.bind.annotation.*;
31
-
32
-
@RestController
33
-
@SpringBootApplication
34
-
public class Example {
29
+
import org.springframework.boot.*;
30
+
import org.springframework.boot.autoconfigure.*;
31
+
import org.springframework.web.bind.annotation.*;
35
32
36
-
@RequestMapping("/")
37
-
String home() {
38
-
return "Hello World!";
39
-
}
33
+
@RestController
34
+
@SpringBootApplication
35
+
public class Example {
40
36
41
-
public static void main(String[] args) {
42
-
SpringApplication.run(Example.class, args);
43
-
}
37
+
@RequestMapping("/")
38
+
String home() {
39
+
return "Hello World!";
40
+
}
44
41
42
+
public static void main(String[] args) {
43
+
SpringApplication.run(Example.class, args);
45
44
}
45
+
46
+
}
46
47
----
47
48
48
49
49
50
50
51
== Getting Help
52
+
51
53
Are you having trouble with Spring Boot? We want to help!
52
54
53
55
* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] -- they provide solutions to the most common questions.
@@ -61,6 +63,7 @@ Are you having trouble with Spring Boot? We want to help!
61
63
62
64
63
65
== Reporting Issues
66
+
64
67
Spring Boot uses GitHub's integrated issue tracking system to record bugs and feature requests.
65
68
If you want to raise an issue, please follow the recommendations below:
66
69
@@ -75,31 +78,34 @@ We like to know the Spring Boot version, operating system, and JVM version you'r
75
78
76
79
77
80
== Building from Source
81
+
78
82
You don't need to build from source to use Spring Boot (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Boot can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
79
83
You also need JDK 17.
80
84
81
-
[indent=0]
85
+
[source,shell]
82
86
----
83
-
$ ./gradlew publishToMavenLocal
87
+
$ ./gradlew publishToMavenLocal
84
88
----
85
89
86
90
This will build all of the jars and documentation and publish them to your local Maven cache.
87
91
It won't run any of the tests.
88
92
If you want to build everything, use the `build` task:
89
93
90
-
[indent=0]
94
+
[source,shell]
91
95
----
92
-
$ ./gradlew build
96
+
$ ./gradlew build
93
97
----
94
98
95
99
96
100
97
101
== Modules
102
+
98
103
There are several modules in Spring Boot. Here is a quick overview:
99
104
100
105
101
106
102
107
=== spring-boot
108
+
103
109
The main library providing features that support the other parts of Spring Boot. These include:
104
110
105
111
* The `SpringApplication` class, providing static convenience methods that can be used to write a stand-alone Spring Application.
@@ -111,6 +117,7 @@ The main library providing features that support the other parts of Spring Boot.
111
117
112
118
113
119
=== spring-boot-autoconfigure
120
+
114
121
Spring Boot can configure large parts of typical applications based on the content of their classpath.
115
122
A single `@EnableAutoConfiguration` annotation triggers auto-configuration of the Spring context.
116
123
@@ -120,13 +127,15 @@ Auto-configuration will always back away as the user starts to define their own
120
127
121
128
122
129
=== spring-boot-starters
130
+
123
131
Starters are a set of convenient dependency descriptors that you can include in your application.
124
132
You get a one-stop shop for all the Spring and related technology you need without having to hunt through sample code and copy-paste loads of dependency descriptors.
125
133
For example, if you want to get started using Spring and JPA for database access, include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go.
126
134
127
135
128
136
129
137
=== spring-boot-actuator
138
+
130
139
Actuator endpoints let you monitor and interact with your application.
131
140
Spring Boot Actuator provides the infrastructure required for actuator endpoints.
132
141
It contains annotation support for actuator endpoints.
@@ -135,6 +144,7 @@ This module provides many endpoints, including the `HealthEndpoint`, `Environmen
135
144
136
145
137
146
=== spring-boot-actuator-autoconfigure
147
+
138
148
This provides auto-configuration for actuator endpoints based on the content of the classpath and a set of properties.
139
149
For instance, if Micrometer is on the classpath, it will auto-configure the `MetricsEndpoint`.
140
150
It contains configuration to expose endpoints over HTTP or JMX.
@@ -143,29 +153,34 @@ Just like Spring Boot AutoConfigure, this will back away as the user starts to d
143
153
144
154
145
155
=== spring-boot-test
156
+
146
157
This module contains core items and annotations that can be helpful when testing your application.
147
158
148
159
149
160
150
161
=== spring-boot-test-autoconfigure
162
+
151
163
Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure provides auto-configuration for tests based on the classpath.
152
164
It includes many annotations that can automatically configure a slice of your application that needs to be tested.
153
165
154
166
155
167
156
168
=== spring-boot-loader
169
+
157
170
Spring Boot Loader provides the secret sauce that allows you to build a single jar file that can be launched using `java -jar`.
158
171
Generally, you will not need to use `spring-boot-loader` directly but work with the link:spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin[Gradle] or link:spring-boot-project/spring-boot-tools/spring-boot-maven-plugin[Maven] plugin instead.
159
172
160
173
161
174
162
175
=== spring-boot-devtools
176
+
163
177
The spring-boot-devtools module provides additional development-time features, such as automatic restarts, for a smoother application development experience.
164
178
Developer tools are automatically disabled when running a fully packaged application.
165
179
166
180
167
181
168
182
== Guides
183
+
169
184
The https://spring.io/[spring.io] site contains several guides that show how to use Spring Boot step-by-step:
170
185
171
186
* https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] is an introductory guide that shows you how to create an application, run it, and add some management services.
@@ -175,4 +190,5 @@ The https://spring.io/[spring.io] site contains several guides that show how to
175
190
176
191
177
192
== License
193
+
178
194
Spring Boot is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
0 commit comments