root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Polishing

This commit is contained in:
Sam Brannen 2019-11-05 15:27:46 +01:00 committed by GitHub
parent fc1dcddb75
commit f9c1f136c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -24,13 +24,13 @@ Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
#### Discuss #### Discuss
If you have a question, check StackOverflow using If you have a question, check Stack Overflow using
[this list of tags](https://spring.io/questions), organized by Spring project. [this list of tags](https://spring.io/questions), organized by Spring project.
Find an existing discussion or start a new one if necessary. Find an existing discussion, or start a new one if necessary.
If you suspect an issue, perform a search in the If you suspect an issue, perform a search in the
[GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues), using a few different keywords. [GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues), using a few different keywords.
When you find related issues and discussions, prior or current, it helps you to learn and When you find related issues and discussions, prior or current, it helps you to learn, and
it helps us to make a decision. it helps us to make a decision.
#### Create a Ticket #### Create a Ticket
@ -40,14 +40,14 @@ and the conversations that result from it provide a continuous flow of ideas.
Before you create a ticket, please take the time to [research first](#discuss). Before you create a ticket, please take the time to [research first](#discuss).
If creating a ticket after a discussion on StackOverflow, please provide a self-sufficient description in the ticket, independent of the details on StackOverflow. 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. If creating a ticket after a discussion on Stack Overflow, please provide a self-sufficient description in the ticket, independent of the details on Stack Overflow. 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.
When ready create a ticket in the [GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues). Once you're ready, create a ticket in the [GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues).
#### Ticket Lifecycle #### Ticket Lifecycle
When an issue is first created, it is flagged `waiting-for-triage` waiting for a team When an issue is first created, it is flagged `waiting-for-triage` waiting for a team
member to triage it. Within a day or two, the issue will then be reviewed and the team member to triage it. Within a day or two, the issue will then be reviewed, and the team
may ask for further information if needed. Based on the findings, the issue is either may ask for further information if needed. Based on the findings, the issue is either
assigned a fix version or declined. assigned a fix version or declined.
@ -80,12 +80,12 @@ otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-war
1. Choose the granularity of your commits consciously and squash commits that represent 1. Choose the granularity of your commits consciously and squash commits that represent
multiple edits or corrections of the same logical change. See multiple edits or corrections of the same logical change. See
[Rewriting History section of Pro Git](https://git-scm.com/book/en/Git-Tools-Rewriting-History) [Rewriting History section of Pro Git](https://git-scm.com/book/en/Git-Tools-Rewriting-History)
for an overview of streamlining commit history. for an overview of streamlining the commit history.
1. Format commit messages using 55 characters for the subject line, 72 characters per line 1. Format commit messages using 55 characters for the subject line, 72 characters per line
for the description, followed by the issue fixed, e.g. `Closes gh-22276`. See the for the description, followed by the issue fixed, e.g. `Closes gh-22276`. See the
[Commit Guidelines section of Pro Git](https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines) [Commit Guidelines section of Pro Git](https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines)
for best practices around commit messages and use `git log` to see some examples. for best practices around commit messages, and use `git log` to see some examples.
1. List the GitHub issue number in the PR description. 1. List the GitHub issue number in the PR description.
@ -115,15 +115,15 @@ source code into your IDE.
The wiki pages The wiki pages
[Code Style](https://github.com/spring-projects/spring-framework/wiki/Code-Style) and [Code Style](https://github.com/spring-projects/spring-framework/wiki/Code-Style) and
[IntelliJ IDEA Editor Settings](https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings) [IntelliJ IDEA Editor Settings](https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings)
defines the source file coding standards we use along with some IDEA editor settings we customize. define the source file coding standards we use along with some IDEA editor settings we customize.
### Reference Docs ### Reference Docs
The reference documentation is in the [src/docs/asciidoc](src/docs/asciidoc) directory and, in The reference documentation is in the [src/docs/asciidoc](src/docs/asciidoc) directory, in
[Asciidoctor](https://asciidoctor.org/) format. For trivial changes, you may be able to browse, [Asciidoctor](https://asciidoctor.org/) format. For trivial changes, you may be able to browse,
edit source files, and submit directly from GitHub. edit source files, and submit directly from GitHub.
When making changes locally, use `./gradlew asciidoctor` and then browse the result under When making changes locally, execute `./gradlew asciidoctor` and then browse the result under
`build/asciidoc/html5/index.html`. `build/asciidoc/html5/index.html`.
Asciidoctor also supports live editing. For more details read Asciidoctor also supports live editing. For more details read