Skip to content

Commit 936d63b

Browse files
artembilangaryrussell
authored andcommitted
Update CONTRIBUTING for GH issues bug tracking (#2696)
* Update CONTRIBUTING for GH issues bug tracking * * Still mention JIRA
1 parent 518c491 commit 936d63b

File tree

1 file changed

+48
-63
lines changed

1 file changed

+48
-63
lines changed

CONTRIBUTING.adoc

Lines changed: 48 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,27 @@ what kind of changes are likely to be accepted; and what to expect from the Spri
77
Please refer back to this document as a checklist before issuing any pull request; this will save time for everyone!
88

99
== Code of Conduct
10+
1011
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
11-
By participating, you are expected to uphold this code. Please report unacceptable behavior to
12-
12+
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
1313

1414
== Understand the basics
1515

16-
Not sure what a *pull request* is, or how to submit one? Take a look at GitHub's excellent documentation:
17-
https://help.github.com/articles/using-pull-requests/[Using Pull Requests] first.
16+
Not sure what a *pull request* is, or how to submit one?
17+
Take a look at GitHub's excellent documentation: https://help.github.com/articles/using-pull-requests/[Using Pull Requests] first.
1818

19-
== Search JIRA first; create an issue if necessary
19+
== Search GitHub (or JIRA) issues first; create one if necessary
2020

21-
Is there already an issue that addresses your concern? Search the
22-
https://jira.springsource.org/browse/INT[JIRA issue tracker] to see if you can find something similar.
23-
If not, please create a new issue before submitting a pull request unless the change is truly trivial, e.g. typo fixes,
24-
removing compiler warnings, etc.
21+
Is there already an issue that addresses your concern?
22+
Search the https://github.com/spring-projects/spring-integration/issues[GitHub issue tracker] (or https://jira.springsource.org/browse/INT[JIRA issue tracker]) to see if you can find something similar.
23+
If not, please create a new issue before submitting a pull request unless the change is truly trivial, e.g. typo fixes, removing compiler warnings, etc.
2524

2625
== Sign the contributor license agreement
2726

28-
If you have not previously done so, please fill out and
29-
submit the https://cla.pivotal.io/sign/spring[Contributor License Agreement (CLA)].
27+
If you have not previously done so, please fill out and submit the https://cla.pivotal.io/sign/spring[Contributor License Agreement (CLA)].
3028

31-
Very important, before we can accept any *Spring Integration contributions*, we will need you to sign the CLA. Signing the CLA does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
29+
Very important, before we can accept any *Spring Integration contributions*, we will need you to sign the CLA.
30+
Signing the CLA does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
3231

3332
== Fork the Repository
3433

@@ -47,57 +46,46 @@ _you should see only 'origin' - which is the fork you created for your own githu
4746
_you should now see 'upstream' in addition to 'origin' where 'upstream' is the SpringSource repository from which releases are built_
4847
6. `git fetch --all`
4948
7. `git branch -a`
50-
_you should see branches on origin as well as upstream, including 'master' and 'maint'_
49+
_you should see branches on origin as well as upstream, including 'master'_
5150

5251
== A Day in the Life of a Contributor
5352

54-
* _Always_ work on topic branches (Typically use the Jira ticket ID as the branch name).
55-
- For example, to create and switch to a new branch for issue INT-123: `git checkout -b INT-123`
53+
* _Always_ work on topic branches (Typically use the GitHub issue ID as the branch name).
54+
- For example, to create and switch to a new branch for issue 123: `git checkout -b GH-123`
5655
* You might be working on several different topic branches at any given time, but when at a stopping point for one of those branches, commit (a local operation).
57-
* Please follow the "Commit Guidelines" described in
58-
http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project[this chapter of Pro Git].
59-
* Then to begin working on another issue (say INT-101): `git checkout INT-101`. The _-b_ flag is not needed if that
60-
branch already exists in your local repository.
61-
* When ready to resolve an issue or to collaborate with others, you can push your branch to origin (your fork),
62-
e.g.: `git push origin INT-123`
63-
* If you want to collaborate with another contributor, have them fork your repository (add it as a remote) and
64-
`git fetch <your-username>` to grab your branch.
56+
* Please follow the "Commit Guidelines" described in http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project[this chapter of Pro Git].
57+
* Then to begin working on another issue (say 101): `git checkout GH-101`.
58+
The _-b_ flag is not needed if that branch already exists in your local repository.
59+
* When ready to resolve an issue or to collaborate with others, you can push your branch to origin (your fork), e.g.: `git push origin GH-123`
60+
* If you want to collaborate with another contributor, have them fork your repository (add it as a remote) and `git fetch <your-username>` to grab your branch.
6561
Alternatively, they can use `git fetch --all` to sync their local state with all of their remotes.
6662
* If you grant that collaborator push access to your repository, they can even apply their changes to your branch.
67-
* When ready for your contribution to be reviewed for potential inclusion in the master branch of the canonical
68-
spring-integration repository (what you know as 'upstream'), issue a pull request to the SpringSource repository
69-
(for more detail, see https://help.github.com/articles/using-pull-requests/[Using pull requests]).
70-
* The project lead may merge your changes into the upstream master branch as-is, he may keep the pull request open yet
71-
add a comment about something that should be modified, or he might reject the pull request by closing it.
63+
* When ready for your contribution to be reviewed for potential inclusion in the master branch of the canonical `spring-integration` repository (what you know as 'upstream'), issue a pull request to the SpringSource repository (for more detail, see https://help.github.com/articles/using-pull-requests/[Using pull requests]).
64+
* The project lead may merge your changes into the upstream master branch as-is, he may keep the pull request open yet add a comment about something that should be modified, or he might reject the pull request by closing it.
7265
* A prerequisite for any pull request is that it will be cleanly merge-able with the upstream master's current state.
7366
**This is the responsibility of any contributor.**
74-
If your pull request cannot be applied cleanly, the project lead will most likely add a comment requesting that you make
75-
it merge-able.
67+
If your pull request cannot be applied cleanly, the project lead will most likely add a comment requesting that you make it merge-able.
7668
For a full explanation, see http://git-scm.com/book/en/Git-Branching-Rebasing[the Pro Git section on rebasing].
77-
As stated there: _"> Often, you’ll do this to make sure your commits apply cleanly on a remote branch — perhaps in a
78-
project to which you’re trying to contribute but that you don’t maintain."_
69+
As stated there: _"> Often, you’ll do this to make sure your commits apply cleanly on a remote branch — perhaps in a project to which you’re trying to contribute but that you don’t maintain."_
7970

8071
== Keeping your Local Code in Sync
81-
* As mentioned above, you should always work on topic branches (since 'master' is a moving target). However, you do want
82-
to always keep your own 'origin' master branch in synch with the 'upstream' master.
72+
73+
* As mentioned above, you should always work on topic branches (since 'master' is a moving target). However, you do want to always keep your own 'origin' master branch in synch with the 'upstream' master.
8374
* Within your local working directory, you can sync up all remotes' branches with: `git fetch --all`
84-
* While on your own local master branch: `git pull upstream master` (which is the equivalent of fetching upstream/master
85-
and merging that into the branch you are in currently)
86-
* Now that you're in synch, switch to the topic branch where you plan to work, e.g.: `git checkout -b INT-123`
75+
* While on your own local master branch: `git pull upstream master` (which is the equivalent of fetching upstream/master and merging that into the branch you are in currently)
76+
* Now that you're in synch, switch to the topic branch where you plan to work, e.g.: `git checkout -b GH-123`
8777
* When you get to a stopping point: `git commit`
88-
* If changes have occurred on the upstream/master while you were working you can synch again:
78+
* If changes have occurred on the upstream/master while you were working you can sync again:
8979
- Switch back to master: `git checkout master`
9080
- Then: `git pull upstream master`
91-
- Switch back to the topic branch: `git checkout INT-123` (no -b needed since the branch already exists)
92-
- Rebase the topic branch to minimize the distance between it and your recently synched master branch: `git rebase master`
81+
- Switch back to the topic branch: `git checkout GH-123` (no -b needed since the branch already exists)
82+
- Rebase the topic branch to minimize the distance between it and your recently synced master branch: `git rebase master`
9383
(Again, for more detail see http://git-scm.com/book/en/Git-Branching-Rebasing[the Pro Git section on rebasing]).
9484
* **Note** While it is generally recommended to __not__ re-write history by using `push --force`, and we do not do this on `master` (and release) branches in the main repo, we require topic branches for pull requests to be rebased before merging, in order to maintain a clean timeline and avoid "merge" commits.
9585
* If, while rebasing for the merge, we find significant conflicts, we may ask you to rebase and `push --force` to your topic branch after resolving the conflicts.
96-
* Assuming your pull request is merged into the 'upstream' master, you will end up pulling that change into
97-
your own master eventually and, at that time, you may decide to delete the topic branch from your local repository and
98-
your fork (origin) if you pushed it there.
99-
- to delete the local branch: `git branch -d INT-123`
100-
- to delete the branch from your origin: `git push origin :INT-123`
86+
* Assuming your pull request is merged into the 'upstream' master, you will end up pulling that change into your own master eventually and, at that time, you may decide to delete the topic branch from your local repository and your fork (origin) if you pushed it there.
87+
- to delete the local branch: `git branch -d GH-123`
88+
- to delete the branch from your origin: `git push origin :GH-123`
10189

10290
== Maintain a linear commit history
10391

@@ -118,11 +106,11 @@ git config --global alias.logg 'log --graph --pretty=oneline'
118106
This command, will provide the following output, which in this case shows a nice linear history:
119107

120108
----
121-
* c129a02e6c752b49bacd4a445092a44f66c2a1e9 INT-2721 Increase Timers on JDBC Delayer Tests
122-
* 14e556ce23d49229c420632cef608630b1d82e7d INT-2620 Fix Debug Log
123-
* 6140aa7b2cfb6ae309c55a157e94b44e5d0bea4f INT-3037 Fix JDBC MS Discard After Completion
109+
* c129a02e6c752b49bacd4a445092a44f66c2a1e9 GH-2721 Increase Timers on JDBC Delayer Tests
110+
* 14e556ce23d49229c420632cef608630b1d82e7d GH-2620 Fix Debug Log
111+
* 6140aa7b2cfb6ae309c55a157e94b44e5d0bea4f GH-3037 Fix JDBC MS Discard After Completion
124112
* 077f2b24ea871a3937c513e08241d1c6cb9c9179 Update Spring Social Twitter to 1.0.5
125-
* 6d4f2b46d859c903881a561c35aa28df68f8faf3 INT-3053 Allow task-executor on <reply-listener/>
113+
* 6d4f2b46d859c903881a561c35aa28df68f8faf3 GH-3053 Allow task-executor on <reply-listener/>
126114
* 56f9581b85a8a40bbcf2461ffc0753212669a68d Update Spring Social Twitter version to 1.0.4
127115
----
128116

@@ -165,7 +153,7 @@ Use `@author` tag with your real name, when you change any class e.g.
165153
== Submit JUnit test cases for all behavior changes
166154

167155
Search the codebase to find related unit tests and add additional `@Test` methods within.
168-
It is also acceptable to submit test cases on a per JIRA issue basis.
156+
It is also acceptable to submit test cases on a per GH issue basis.
169157

170158
== Squash commits
171159

@@ -174,11 +162,12 @@ In addition to the man pages for git, there are many resources online to help yo
174162

175163
== Use your real name in git commits
176164

177-
Please configure git to use your real first and last name for any commits you intend to submit as pull requests. For example, this is not acceptable:
165+
Please configure git to use your real first and last name for any commits you intend to submit as pull requests.
166+
For example, this is not acceptable:
178167

179168
Author: Nickname <[email protected]>
180169

181-
Rather, please include your first and last name, properly capitalized, as submitted against the SpringSource contributor license agreement:
170+
Rather, please include your first and last name, properly capitalized, as submitted against the SpringIO contributor license agreement:
182171

183172
Author: First Last <[email protected]>
184173

@@ -197,23 +186,17 @@ or locally for the *spring-integration* repository only by omitting the '--globa
197186

198187
== Run all tests prior to submission
199188

200-
See the https://github.com/spring-projects/spring-integration#checking-out-and-building[checking out and building]
201-
section of the README for instructions.
189+
See the https://github.com/spring-projects/spring-integration#checking-out-and-building[checking out and building] section of the README for instructions.
202190
Make sure that all tests pass prior to submitting your pull request.
203191

204-
== Mention your pull request on the associated JIRA issue
205-
206-
Add a comment to the associated JIRA issue(s) linking to your new pull request.
192+
== Provide a Link to the GitHub issue in the Associated Pull Request
207193

208-
== Provide a Link to the JIRA issue in the Associated Pull Request
209-
210-
Add a JIRA issue link to your first commit comment of the pull request on the last line, so your commit message
211-
may look like this:
194+
Add a GitHub issue link to your first commit comment of the pull request on the last line, so your commit message may look like this:
212195

213196
----
214-
INT-1639: Add <spel-function> support
197+
GH-1639: Add <spel-function> support
215198
216-
JIRA: https://jira.springsource.org/browse/INT-1639
199+
Fixes spring-projects/spring-integration#1639
217200
218201
* add `<spel-function>` XSD element
219202
* add `SpelFunctionParser`
@@ -222,3 +205,5 @@ may look like this:
222205
* some refactoring for `IntegrationEvaluationContextFactoryBean`
223206
* polishing some failed tests after this change
224207
----
208+
209+
Please, follow Chris Beams' recommendations in regards to the good commit message: https://chris.beams.io/posts/git-commit[How to Write a Git Commit Message].

0 commit comments

Comments
 (0)