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.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ If you have a question, check StackOverflow using
29
29
Find an existing discussion or start a new one if necessary.
30
30
31
31
If you suspect an issue, perform a search in the
32
-
[JIRA issue tracker](https://jira.spring.io/browse/SPR), using a few different keywords.
32
+
[GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues), using a few different keywords.
33
33
When you find related issues and discussions, prior or current, it helps you to learn and
34
34
it helps us to make a decision.
35
35
@@ -42,7 +42,7 @@ Before you create a ticket, please take the time to [research first](#discuss).
42
42
43
43
If creating a ticket after a discussion on StackOverflow, please provide a self-sufficient description in the ticket, independent of the details on StackOverview. We understand this is extra work but the issue tracker is an important place of record for design discussions and decisions that can often be referenced long after the fix version, for example to revisit decisions, to understand the origin of a feature, and so on.
44
44
45
-
When ready create a ticket in the [JIRA issue tracker](https://jira.spring.io/browse/SPR).
45
+
When ready create a ticket in the [GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues).
46
46
47
47
#### Ticket Lifecycle
48
48
@@ -66,7 +66,7 @@ automatically when you submit a pull request.
66
66
67
67
1. For all but the most trivial of contributions, please [create a ticket](#create-a-ticket).
68
68
The purpose of the ticket is to understand and discuss the underlying issue or feature.
69
-
We use the JIRA issue tracker as the preferred place of record for conversations and
69
+
We use the GitHub issue tracker as the preferred place of record for conversations and
70
70
conclusions. In that sense discussions directly under a PR are more implementation detail
71
71
oriented and transient in nature.
72
72
@@ -75,21 +75,21 @@ oriented and transient in nature.
75
75
Backports to prior versions will be considered on a case-by-case basis and reflected as
76
76
the fix version in the issue tracker.
77
77
78
-
1. Use short branch names, preferably based on the JIRA issue (e.g. `SPR-1234`), or
79
-
otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-warnings'.
78
+
1. Use short branch names, preferably based on the GitHub issue (e.g. `22276`), or
79
+
otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-warnings`.
80
80
81
81
1. Choose the granularity of your commits consciously and squash commits that represent
82
82
multiple edits or corrections of the same logical change. See
83
83
[Rewriting History section of Pro Git](http://git-scm.com/book/en/Git-Tools-Rewriting-History)
84
84
for an overview of streamlining commit history.
85
85
86
86
1. Format commit messages using 55 characters for the subject line, 72 lines for the
87
-
description, followed by related issues, e.g. `Issues: SPR-1234, SPR-1235`.
87
+
description, followed by the issue fixed, e.g. `Fixes #22276`.
88
88
See the
89
89
[Commit Guidelines section of Pro Git](http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines)
90
90
for best practices around commit messages and use `git log` to see some examples.
91
91
92
-
1. List the JIRA issue number in the PR description.
92
+
1. List the GitHub issue number in the PR description.
93
93
94
94
If accepted, your contribution may be heavily modified as needed prior to merging.
95
95
You will likely retain author attribution for your Git commits granted that the bulk of
@@ -116,7 +116,7 @@ defines the source file coding standards we use along with some IDEA editor sett
116
116
117
117
The reference documentation is in the [src/docs/asciidoc](src/docs/asciidoc) directory and, in
118
118
[Asciidoctor](http://asciidoctor.org/) format. For trivial changes, you may be able to browse,
119
-
edit source files, and submit directly from Github.
119
+
edit source files, and submit directly from GitHub.
120
120
121
121
When making changes locally, use `./gradlew asciidoctor` and then browse the result under
# <imgsrc="src/docs/asciidoc/images/spring-framework.png"width="80"height="80"> Spring Framework
2
2
3
-
This is the home of the Spring Framework, the foundation for all
4
-
[Spring projects](https://spring.io/projects). Together the Spring Framework and the family of Spring projects make up what we call "Spring".
3
+
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 is often referred to simply as "Spring".
5
4
6
-
Spring provides everything you need beyond the Java language to create enterprise
7
-
applications in a wide range of scenarios and architectures. Please read the
section in the reference for a more complete introduction.
5
+
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/docs/current/spring-framework-reference/overview.html#spring-introduction) section as reference for a more complete introduction.
10
6
11
7
## Code of Conduct
12
8
13
-
This project is governed by the [Spring Code of Conduct](CODE_OF_CONDUCT.adoc).
14
-
By participating you are expected to uphold this code.
This project is governed by the [Spring Code of Conduct](CODE_OF_CONDUCT.adoc). By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected].
16
10
17
11
## Access to Binaries
18
12
19
-
For access to artifacts or a distribution zip, see the
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.
22
14
23
15
## Documentation
24
16
25
-
The Spring Frameworks maintains reference documentation
26
-
([published](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/) and
27
-
[source](src/docs/asciidoc)),
28
-
Github [wiki pages](https://github.com/spring-projects/spring-framework/wiki), and an
There are also [guides and tutorials](https://spring.io/guides) across Spring projects.
17
+
The Spring Framework maintains reference documentation ([published](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/) and [source](src/docs/asciidoc)), Github [wiki pages](https://github.com/spring-projects/spring-framework/wiki), and an
18
+
[API reference](http://docs.spring.io/spring-framework/docs/current/javadoc-api/). There are also [guides and tutorials](https://spring.io/guides) across Spring projects.
31
19
32
20
## Build from Source
33
21
34
-
See the [Build from Source](https://github.com/spring-projects/spring-framework/wiki/Build-from-Source)
35
-
wiki page and also [CONTRIBUTING.md](CONTRIBUTING.md).
22
+
See the [Build from Source](https://github.com/spring-projects/spring-framework/wiki/Build-from-Source) Wikipedia page and the [CONTRIBUTING.md](CONTRIBUTING.md) file.
[@SpringFramework](https://twitter.com/springframework), and its
41
-
[team members](https://twitter.com/springframework/lists/team/members) on Twitter.
42
-
In-depth articles can be found at [The Spring Blog](http://spring.io/blog/),
43
-
and releases are announced via our [news feed](http://spring.io/blog/category/news).
26
+
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).
44
27
45
28
## License
46
29
47
-
The Spring Framework is released under version 2.0 of the
0 commit comments