Skip to content

Commit 08669cc

Browse files
committed
Updates to CONTRIBUTING.md
Closes gh-22892
1 parent db97dac commit 08669cc

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ First off, thank you for taking the time to contribute! :+1: :tada:
77
* [Code of Conduct](#code-of-conduct)
88
* [How to Contribute](#how-to-contribute)
99
* [Discuss](#discuss)
10-
* [Create a Ticket](#create-a-ticket)
11-
* [Ticket Lifecycle](#ticket-lifecycle)
10+
* [Create an Issue](#create-an-issue)
11+
* [Issue Lifecycle](#issue-lifecycle)
1212
* [Submit a Pull Request](#submit-a-pull-request)
1313
* [Build from Source](#build-from-source)
1414
* [Source Code Style](#source-code-style)
@@ -28,56 +28,55 @@ If you have a question, check Stack Overflow using
2828
[this list of tags](https://spring.io/questions), organized by Spring project.
2929
Find an existing discussion, or start a new one if necessary.
3030

31-
If you find an issue, perform a search in the
32-
[GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues), using a few different keywords.
33-
If you find discussions related to your issue either past or current, read them as it helps you learn about the issue
34-
and helps us make a decision on the issue.
31+
If you believe there is an issue, search through
32+
[existing issues](https://github.com/spring-projects/spring-framework/issues) trying a
33+
few different ways to find discussions, past or current, that are related to the issue.
34+
Reading those discussions helps you to learn about the issue, and helps us to make a
35+
decision.
3536

3637

37-
#### Create a Ticket
38+
#### Create an Issue
3839

3940
Reporting an issue or making a feature request is a great way to contribute. Your feedback
40-
and the conversations that result from it provide a continuous flow of ideas.
41+
and the conversations that result from it provide a continuous flow of ideas. However,
42+
before creating a ticket, please take the time to [discuss and research](#discuss) first.
4143

42-
Before you create a ticket, please take the time to [research first](#discuss).
44+
If creating an issue after a discussion on Stack Overflow, please provide a description
45+
in the issue instead of simply referring to Stack Overflow. The issue tracker is an
46+
important place of record for design discussions and should be self-sufficient.
4347

44-
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.
48+
Once you're ready, create an issue on
49+
[GitHub](https://github.com/spring-projects/spring-framework/issues).
4550

46-
Once you're ready, create a ticket in the [GitHub issue tracker](https://github.com/spring-projects/spring-framework/issues).
47-
48-
#### Ticket Lifecycle
51+
#### Issue Lifecycle
4952

5053
When an issue is first created, it is flagged `waiting-for-triage` waiting for a team
51-
member to triage it. Within a day or two, the issue will then be reviewed, and the team
52-
may ask for further information if needed. Based on the findings, the issue is either
53-
assigned a fix version or declined.
54+
member to triage it. Once the issue has been reviewed, the team may ask for further
55+
information if needed, and based on the findings, the issue is either assigned a target
56+
milestone or is closed with a specific status.
5457

55-
When a fix is ready, the issue is closed and may still be re-opened. Once a fix is
56-
released, the issue can't be reopened. If necessary, you will need to create a new,
57-
related ticket with a fresh description.
58+
When a fix is ready, the issue is closed and may still be re-opened until the fix is
59+
released. After that the issue will typically no longer be reopened. In rare cases if the
60+
issue was not at all fixed, the issue may be re-opened. In most cases however any
61+
follow-up reports will need to be created as new issues with a fresh description.
5862

5963
#### Submit a Pull Request
6064

61-
You can contribute a source code change by submitting a pull request.
62-
6365
1. If you have not previously done so, please sign the
64-
[Contributor License Agreement](https://cla.pivotal.io/sign/spring). You will also be reminded
65-
automatically when you submit a pull request.
66+
[Contributor License Agreement](https://cla.pivotal.io/sign/spring). You will be reminded
67+
automatically when you submit the PR.
6668

67-
1. Should you create a ticket first? The answer is no. Just create the pull request and use
68-
the description to provide context and motivation, as you would for an issue. If you want
69-
to start a discussion first or have already created an issue, once a pull request is created,
70-
we will close the issue as superseded by the pull request, and the discussion of the issue
71-
will continue under the pull request.
69+
1. Should you create an issue first? No, just create the pull request and use the
70+
description to provide context and motivation, as you would for an issue. If you want
71+
to start a discussion first or have already created an issue, once a pull request is
72+
created, we will close the issue as superseded by the pull request, and the discussion
73+
about the issue will continue under the pull request.
7274

7375
1. Always check out the `master` branch and submit pull requests against it
7476
(for target version see [settings.gradle](settings.gradle)).
7577
Backports to prior versions will be considered on a case-by-case basis and reflected as
7678
the fix version in the issue tracker.
7779

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-
8180
1. Choose the granularity of your commits consciously and squash commits that represent
8281
multiple edits or corrections of the same logical change. See
8382
[Rewriting History section of Pro Git](https://git-scm.com/book/en/Git-Tools-Rewriting-History)
@@ -88,7 +87,8 @@ for the description, followed by the issue fixed, e.g. `Closes gh-22276`. See th
8887
[Commit Guidelines section of Pro Git](https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines)
8988
for best practices around commit messages, and use `git log` to see some examples.
9089

91-
1. List the GitHub issue number in the PR description.
90+
1. If there is a prior issue, reference the GitHub issue number in the description of the
91+
pull request.
9292

9393
If accepted, your contribution may be heavily modified as needed prior to merging.
9494
You will likely retain author attribution for your Git commits granted that the bulk of

0 commit comments

Comments
 (0)