Browse Source
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.pull/1578/head
Rossen Stoyanchev
7 years ago
2 changed files with 96 additions and 105 deletions
@ -1,70 +1,81 @@
@@ -1,70 +1,81 @@
|
||||
Please read the |
||||
This is the home of the Spring Framework that underlies all |
||||
[Spring projects](https://spring.io/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](https://docs.spring.io/spring/docs/current/spring-framework-reference/overview.html#spring-introduction) |
||||
in the reference documentation for a quick introduction. |
||||
section in the reference for a more complete introduction. |
||||
|
||||
## Code of Conduct |
||||
|
||||
This project is governed by the [Spring Code of Conduct](CODE_OF_CONDUCT.adoc). |
||||
By participating you are expected to uphold this code. |
||||
Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. |
||||
|
||||
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][]. |
||||
## Artifacts |
||||
|
||||
For Maven repository information see |
||||
[downloading Spring artifacts](https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts), |
||||
or if unable to use Maven or other transitive dependency management tools, see |
||||
[building a distribution with dependencies](https://github.com/spring-projects/spring-framework/wiki/Building-a-distribution-with-dependencies). |
||||
|
||||
Documentation is available in the form of [reference docs][], [Javadoc][], and Github Wiki pages. |
||||
## Learn |
||||
|
||||
For contributing see the [contributor guidelines][] for details. |
||||
The Spring Frameworks maintains |
||||
[reference documentation](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/), |
||||
Github [wiki pages](https://github.com/spring-projects/spring-framework/wiki), and an |
||||
[API reference](http://docs.spring.io/spring-framework/docs/current/javadoc-api/). |
||||
|
||||
## Building from Source |
||||
The Spring Framework uses a [Gradle][]-based build system. In the instructions |
||||
below, [`./gradlew`][] is invoked from the root of the source tree and serves as |
||||
a cross-platform, self-contained bootstrap mechanism for the build. |
||||
You can find guides and tutorials on [https://spring.io](https://spring.io/guides). |
||||
|
||||
### Prerequisites |
||||
## Build from Source |
||||
|
||||
[Git][] and [JDK 8 update 20 or later][JDK8 build] |
||||
The Spring Framework uses a [Gradle](http://gradle.org) build. In the instructions below, |
||||
the [Gradle Wrapper](http://vimeo.com/34436402) 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](http://help.github.com/set-up-git-redirect) and |
||||
[JDK 8 update 20 or later](http://www.oracle.com/technetwork/java/javase/downloads). |
||||
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder |
||||
extracted from the JDK download. |
||||
|
||||
### Check out sources |
||||
`git clone git@github.com:spring-projects/spring-framework.git` |
||||
Start by checking out the sources: |
||||
``` |
||||
git clone git@github.com:spring-projects/spring-framework.git |
||||
``` |
||||
|
||||
### Import sources into your IDE |
||||
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate. |
||||
> **Note:** Per the prerequisites above, ensure that you have JDK 8 configured properly in your IDE. |
||||
To import into an IDE, ensure JDK 8 is configured. Then run `./import-into-eclipse.sh` |
||||
or read [import-into-idea.md](import-into-idea.md). For IntelliJ please do read the |
||||
instructions as a straight-up import will not work. |
||||
|
||||
### Install all spring-\* jars into your local Maven cache |
||||
`./gradlew install` |
||||
To compile, test, build all jars, distribution zips, and docs use: |
||||
``` |
||||
./gradlew build |
||||
``` |
||||
|
||||
### Compile and test; build all jars, distribution zips, and docs |
||||
`./gradlew build` |
||||
To install all spring-\* jars into your local Maven cache: |
||||
``` |
||||
./gradlew install |
||||
``` |
||||
|
||||
... and discover more commands with `./gradlew tasks`. See also the [Gradle |
||||
build and release FAQ][]. |
||||
Discover more commands: |
||||
``` |
||||
./gradlew tasks |
||||
``` |
||||
|
||||
## Staying in Touch |
||||
Follow [@SpringCentral][] as well as [@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][]. |
||||
See also [CONTRIBUTING](CONTRIBUTING.md) and the |
||||
[Gradle build and release FAQ](https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ). |
||||
|
||||
## Stay in Touch |
||||
|
||||
Follow [@SpringCentral](https://twitter.com/springcentral), |
||||
[@SpringFramework](https://twitter.com/springframework), and its |
||||
[team members](https://twitter.com/springframework/lists/team/members) on Twitter. |
||||
In-depth articles can be found at [The Spring Blog](http://spring.io/blog/), |
||||
and releases are announced via our [news feed](http://spring.io/blog/category/news). |
||||
|
||||
## License |
||||
The Spring Framework is released under version 2.0 of the [Apache License][]. |
||||
|
||||
[downloading Spring artifacts]: https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts |
||||
[building a distribution with dependencies]: https://github.com/spring-projects/spring-framework/wiki/Building-a-distribution-with-dependencies |
||||
[Javadoc]: http://docs.spring.io/spring-framework/docs/current/javadoc-api/ |
||||
[reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/ |
||||
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR |
||||
[Gradle]: http://gradle.org |
||||
[`./gradlew`]: http://vimeo.com/34436402 |
||||
[Git]: http://help.github.com/set-up-git-redirect |
||||
[JDK8 build]: http://www.oracle.com/technetwork/java/javase/downloads |
||||
[Gradle build and release FAQ]: https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ |
||||
[Pull requests]: https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/ |
||||
[contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.adoc |
||||
[@SpringFramework]: https://twitter.com/springframework |
||||
[@SpringCentral]: https://twitter.com/springcentral |
||||
[team members]: https://twitter.com/springframework/lists/team/members |
||||
[The Spring Blog]: http://spring.io/blog/ |
||||
[news feed]: http://spring.io/blog/category/news |
||||
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
The Spring Framework is released under version 2.0 of the |
||||
[Apache License](http://www.apache.org/licenses/LICENSE-2.0). |
||||
|
Loading…
Reference in new issue