5ac377499c
The main way CONTRIBUTING will be viewed is on Github and the output is just not good enough to justify using asciidoctor vs md/txt as the recommended on the Github help page for contributing guidelines. For example it was attractive to use a TOC and that works on Github but doesn't look good. In the end it's a very short TOC and maintaining manually is easy enough and it's easier to control the look. |
||
|---|---|---|
| .settings/gradle | ||
| buildSrc | ||
| gradle | ||
| spring-aop | ||
| spring-aspects | ||
| spring-beans | ||
| spring-context | ||
| spring-context-indexer | ||
| spring-context-support | ||
| spring-core | ||
| spring-expression | ||
| spring-framework-bom | ||
| spring-instrument | ||
| spring-jcl | ||
| spring-jdbc | ||
| spring-jms | ||
| spring-messaging | ||
| spring-orm | ||
| spring-oxm | ||
| spring-test | ||
| spring-tx | ||
| spring-web | ||
| spring-webflux | ||
| spring-webmvc | ||
| spring-websocket | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .mailmap | ||
| CODE_OF_CONDUCT.adoc | ||
| CONTRIBUTING.md | ||
| README.md | ||
| build.gradle | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| import-into-eclipse.bat | ||
| import-into-eclipse.sh | ||
| import-into-idea.md | ||
| settings.gradle | ||
README.md
This is the home of the Spring Framework that underlies all Spring projects. Collectively the Spring Framework and the family of related Spring projects make up what we call "Spring".
Spring provides everything you need beyond the Java language to create enterprise applications in a wide range of scenarios and architectures. Please read the Overview section in the reference for a more complete introduction.
Code of Conduct
This project is governed by the Spring Code of Conduct. By participating you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
Artifacts
For Maven repository information see downloading Spring artifacts, or if unable to use Maven or other transitive dependency management tools, see building a distribution with dependencies.
Learn
The Spring Frameworks maintains reference documentation, Github wiki pages, and an API reference.
You can find guides and tutorials on https://spring.io.
Build from Source
The Spring Framework uses a Gradle build. In the instructions below, the Gradle Wrapper is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build.
To build you will need Git and
JDK 8 update 20 or later.
Be sure that your JAVA_HOME environment variable points to the jdk1.8.0 folder
extracted from the JDK download.
Start by checking out the sources:
git clone git@github.com:spring-projects/spring-framework.git
To import into an IDE, ensure JDK 8 is configured. Then run ./import-into-eclipse.sh
or read import-into-idea.md. For IntelliJ please do read the
instructions as a straight-up import will not work.
To compile, test, build all jars, distribution zips, and docs use:
./gradlew build
To install all spring-* jars into your local Maven cache:
./gradlew install
Discover more commands:
./gradlew tasks
See also CONTRIBUTING and the Gradle build and release FAQ.
Stay in Touch
Follow @SpringCentral, @SpringFramework, and its team members on Twitter. In-depth articles can be found at The Spring Blog, and releases are announced via our news feed.
License
The Spring Framework is released under version 2.0 of the Apache License.