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
* 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.
62
62
Alternatively, they can use `git fetch --all` to sync their local state with all of their remotes.
63
63
* If you grant those collaborator(s) push access to your repository, they can even apply their changes to your branch.
64
-
* When ready for your contribution to be reviewed for potential inclusion in the master branch of the canonical spring-amqp 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]).
65
-
* 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.
66
-
* A prerequisite for any pull request is that it will be cleanly merge-able with the upstream master's current state.
64
+
* When ready for your contribution to be reviewed for potential inclusion in the main branch of the canonical spring-amqp 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]).
65
+
* The project lead may merge your changes into the upstream main 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.
66
+
* A prerequisite for any pull request is that it will be cleanly merge-able with the upstream main's current state.
67
67
**This is the responsibility of any contributor.**
68
68
If your pull request cannot be applied cleanly, the project lead will most likely add a comment requesting that you make it merge-able.
69
69
For a full explanation, see https://git-scm.com/book/en/Git-Branching-Rebasing[the Pro Git section on rebasing].
70
70
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."_
71
71
72
72
== Keeping your Local Code in Sync
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.
73
+
* As mentioned above, you should always work on topic branches (since 'main' is a moving target). However, you do want to always keep your own 'origin' main branch in synch with the 'upstream' main.
74
74
* Within your local working directory, you can sync up all remotes' branches with: `git fetch --all`
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)
75
+
* While on your own local main branch: `git pull upstream main` (which is the equivalent of fetching upstream/main and merging that into the branch you are in currently)
76
76
* Now that you're in synch, switch to the topic branch where you plan to work, e.g.: `git checkout -b AMQP-123`
77
77
* When you get to a stopping point: `git commit`
78
-
* If changes have occurred on the upstream/master while you were working you can synch again:
79
-
- Switch back to master: `git checkout master`
80
-
- Then: `git pull upstream master`
78
+
* If changes have occurred on the upstream/main while you were working you can synch again:
79
+
- Switch back to main: `git checkout main`
80
+
- Then: `git pull upstream main`
81
81
- Switch back to the topic branch: `git checkout AMQP-123` (no -b needed since the branch already exists)
82
-
- Rebase the topic branch to minimize the distance between it and your recently synched master branch: `git rebase master`
82
+
- Rebase the topic branch to minimize the distance between it and your recently synched main branch: `git rebase main`
83
83
(Again, for more detail see https://git-scm.com/book/en/Git-Branching-Rebasing[the Pro Git section on rebasing]).
84
-
* **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.
84
+
* **Note** While it is generally recommended to __not__ re-write history by using `push --force`, and we do not do this on `main` (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.
85
85
* 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.
86
-
* Assuming your pull request is merged into the 'upstream' master, you will actually end up pulling that change into
87
-
your own master eventually, and at that time, you may decide to delete the topic branch from your local repository and
86
+
* Assuming your pull request is merged into the 'upstream' main, you will actually end up pulling that change into
87
+
your own main eventually, and at that time, you may decide to delete the topic branch from your local repository and
88
88
your fork (origin) if you pushed it there.
89
89
- to delete the local branch: `git branch -d GH-123`
90
90
- to delete the branch from your origin: `git push origin :GH-123`
91
91
92
92
== Maintain a linear commit history
93
93
94
-
When merging to master, the project __always__ uses fast-forward merges.
94
+
When merging to main, the project __always__ uses fast-forward merges.
95
95
When issuing pull requests, please ensure that your commit history is linear.
96
96
From the command line you can check this using:
97
97
@@ -117,7 +117,7 @@ This command, will provide the following output, which in this case shows a nice
117
117
----
118
118
119
119
If you see intersecting lines, that usually means that you forgot to rebase you branch.
120
-
As mentioned earlier, **please rebase against master** before issuing a pull request.
120
+
As mentioned earlier, **please rebase against main** before issuing a pull request.
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Spring AMQP [<imgsrc="https://build.spring.io/plugins/servlet/wittified/build-status/AMQP-MASTER">](https://build.spring.io/browse/AMQP-MASTER)[](https://gitter.im/spring-projects/spring-amqp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1
+
Spring AMQP [<imgsrc="https://build.spring.io/plugins/servlet/wittified/build-status/AMQP-MAIN">](https://build.spring.io/browse/AAMQP-MAIN)[](https://gitter.im/spring-projects/spring-amqp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2
2
===========
3
3
4
4
This project provides support for using Spring and Java with [AMQP 0.9.1](https://www.rabbitmq.com/amqp-0-9-1-reference.html), and in particular [RabbitMQ](https://www.rabbitmq.com/).
@@ -115,7 +115,7 @@ None of these is essential for a pull request, but they will all help. They can
115
115
* Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
116
116
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
117
117
* A few unit tests would help a lot as well - someone has to do it.
118
-
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
118
+
* If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project).
0 commit comments