mirror of
https://github.com/spring-projects/spring-framework.git
synced 2026-10-03 21:49:03 +00:00
Sébastien Deleuze
c377da58d9
Prior to this commit, CONTRIBUTING.md delegated build instructions and code style to wiki pages, which are planned for removal. This commit inlines the build, code style and testing guidelines into CONTRIBUTING.md, aligns them with the current build and Checkstyle rules, and documents the commit message conventions, the security policy and the policy on AI-assisted contributions. It also adds a concise AGENTS.md extract for coding agents, and updates the README to link to the Build from Source section. Closes gh-37372 Signed-off-by: Sébastien Deleuze <sdeleuze@users.noreply.github.com>
39 lines
2.9 KiB
Markdown
39 lines
2.9 KiB
Markdown
# <img src="framework-docs/src/docs/spring-framework.png" width="80" height="80"> Spring Framework [](https://github.com/spring-projects/spring-framework/actions/workflows/build-and-deploy-snapshot.yml?query=branch%3Amain) [](https://ge.spring.io/scans?search.rootProjectNames=spring)
|
||
|
||
This is the home of the Spring Framework: the foundation for all [Spring projects](https://spring.io/projects). Collectively the Spring Framework and the family of Spring projects are often referred to simply as "Spring".
|
||
|
||
Spring provides everything required beyond the Java programming language for creating enterprise applications for a wide range of scenarios and architectures. Please read the [Overview](https://docs.spring.io/spring-framework/reference/overview.html) section of the reference documentation for a more complete introduction.
|
||
|
||
## Code of Conduct
|
||
|
||
This project is governed by the [Spring Code of Conduct](https://github.com/spring-projects/spring-framework/?tab=coc-ov-file#contributor-code-of-conduct). By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@spring.io.
|
||
|
||
## Access to Binaries
|
||
|
||
For access to artifacts or a distribution zip, see the [Spring Framework Artifacts](https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-Artifacts) wiki page.
|
||
|
||
## Documentation
|
||
|
||
The Spring Framework maintains reference documentation ([published](https://docs.spring.io/spring-framework/reference/) and [source](framework-docs/modules/ROOT)), GitHub [wiki pages](https://github.com/spring-projects/spring-framework/wiki), and an
|
||
[API reference](https://docs.spring.io/spring-framework/docs/current/javadoc-api/). There are also [guides and tutorials](https://spring.io/guides) across Spring projects.
|
||
|
||
## Micro-Benchmarks
|
||
|
||
See the [Micro-Benchmarks](https://github.com/spring-projects/spring-framework/wiki/Micro-Benchmarks) wiki page.
|
||
|
||
## Build from Source
|
||
|
||
See the [Build from Source](CONTRIBUTING.md#build-from-source) section of the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
||
|
||
## Continuous Integration Builds
|
||
|
||
CI builds are defined with [GitHub Actions workflows](.github/workflows).
|
||
|
||
## 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 𝕏. In-depth articles can be found at [The Spring Blog](https://spring.io/blog/), and releases are announced via our [releases feed](https://spring.io/blog/category/releases).
|
||
|
||
## License
|
||
|
||
The Spring Framework is released under version 2.0 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).
|