You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by GitBox <gi...@apache.org> on 2021/04/22 07:41:02 UTC
[GitHub] [cassandra] bereng opened a new pull request #979: Fix How-to Commit docs
bereng opened a new pull request #979:
URL: https://github.com/apache/cassandra/pull/979
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng closed pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
bereng closed pull request #979:
URL: https://github.com/apache/cassandra/pull/979
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] michaelsembwever commented on a change in pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #979:
URL: https://github.com/apache/cassandra/pull/979#discussion_r620140980
##########
File path: doc/source/development/how_to_commit.rst
##########
@@ -84,6 +84,21 @@ On trunk:
On any branch:
#. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
+.. tip::
+
+ A template for commit messages:
+
+ ::
+
+ <One sentence description, usually Jira title and CHANGES.txt summary>
Review comment:
```suggestion
<One sentence description, usually Jira title or CHANGES.txt summary>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on a change in pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
bereng commented on a change in pull request #979:
URL: https://github.com/apache/cassandra/pull/979#discussion_r620869893
##########
File path: doc/source/development/how_to_commit.rst
##########
@@ -23,66 +23,81 @@ If you are a committer, feel free to pick any process that works for you - so lo
Here is how committing and merging will usually look for merging and pushing for tickets that follow the convention (if patch-based):
-Hypothetical CASSANDRA-12345 ticket is a cassandra-3.0 based bug fix that requires different code for cassandra-3.3, and trunk. Contributor Jackie supplied a patch for the root branch (12345-3.0.patch), and patches for the remaining branches (12345-3.3.patch, 12345-trunk.patch).
+Hypothetical CASSANDRA-12345 ticket is a cassandra-3.0 based bug fix that requires different code for cassandra-3.11, and trunk. Contributor Jackie supplied a patch for the root branch (12345-3.0.patch), and patches for the remaining branches (12345-3.11.patch, 12345-trunk.patch).
On cassandra-3.0:
#. ``git am -3 12345-3.0.patch`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
- #. ``git apply -3 12345-3.3.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
+ #. ``git apply -3 12345-3.11.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the 3.11 applied patch into the forward merge commit)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``git apply -3 12345-trunk.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the trunk applied patch into the forward merge commit)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
Same scenario, but a branch-based contribution:
On cassandra-3.0:
#. ``git cherry-pick <sha-of-3.0-commit>`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
- #. ``git format-patch -1 <sha-of-3.3-commit>``
- #. ``git apply -3 <sha-of-3.3-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
+ #. ``git format-patch -1 <sha-of-3.11-commit>``
+ #. ``git apply -3 <sha-of-3.11-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the 3.11 applied patch into the forward merge commit)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``git format-patch -1 <sha-of-trunk-commit>``
#. ``git apply -3 <sha-of-trunk-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the trunk applied patch into the forward merge commit)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
If the patch is for an older branch, and doesn't impact later branches (such as trunk), we still need to merge up.
On cassandra-3.0:
#. ``git cherry-pick <sha-of-3.0-commit>`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
+
+.. tip::
+
+ A template for commit messages:
+
+ ::
+
+ <One sentence description, usually Jira title and CHANGES.txt summary>
+ <Optional lengthier description>
+
+ patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
+
+
+ Co-authored-by: Name1 <email1>
+ Co-authored-by: Name2 <email2>
Review comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
bereng commented on pull request #979:
URL: https://github.com/apache/cassandra/pull/979#issuecomment-827320582
So I added your `git author` sentence @ekaterinadimitrova2 as it sounds like a good idea. But then I removed it bc it sounded confusing in my head. You can _update_ the author info but you can't _add_ multiple authors i.e. So this is more like a git command than how to format a commit message to GH stds so it parses multiple authors.
They are similar things but not the same hence I removed it. Are you ok with it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] ekaterinadimitrova2 commented on pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
ekaterinadimitrova2 commented on pull request #979:
URL: https://github.com/apache/cassandra/pull/979#issuecomment-827530548
That is what I meant, they are not the same. The idea was to have just the two things mentioned.
You can change the author in case the patch is from someone else but you can't use the original sha.
And also, you can have cases with more than one author
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng edited a comment on pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
bereng edited a comment on pull request #979:
URL: https://github.com/apache/cassandra/pull/979#issuecomment-827320582
So I added your `git author` sentence @ekaterinadimitrova2 as it sounds like a good idea. But then I removed it bc it sounded confusing in my head. You can _update_ the author info but you can't _add_ multiple authors i.e. So this is more like a git command than how to format a commit message to GH stds so it parses multiple authors.
They are similar things but not the same hence I removed it. Are you ok with it?
EDIT: just saw your comment you're ok if this sentence is not added :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] michaelsembwever commented on a change in pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #979:
URL: https://github.com/apache/cassandra/pull/979#discussion_r620142778
##########
File path: doc/source/development/how_to_commit.rst
##########
@@ -23,66 +23,81 @@ If you are a committer, feel free to pick any process that works for you - so lo
Here is how committing and merging will usually look for merging and pushing for tickets that follow the convention (if patch-based):
-Hypothetical CASSANDRA-12345 ticket is a cassandra-3.0 based bug fix that requires different code for cassandra-3.3, and trunk. Contributor Jackie supplied a patch for the root branch (12345-3.0.patch), and patches for the remaining branches (12345-3.3.patch, 12345-trunk.patch).
+Hypothetical CASSANDRA-12345 ticket is a cassandra-3.0 based bug fix that requires different code for cassandra-3.11, and trunk. Contributor Jackie supplied a patch for the root branch (12345-3.0.patch), and patches for the remaining branches (12345-3.11.patch, 12345-trunk.patch).
On cassandra-3.0:
#. ``git am -3 12345-3.0.patch`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
- #. ``git apply -3 12345-3.3.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
+ #. ``git apply -3 12345-3.11.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the 3.11 applied patch into the forward merge commit)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``git apply -3 12345-trunk.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the trunk applied patch into the forward merge commit)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
Same scenario, but a branch-based contribution:
On cassandra-3.0:
#. ``git cherry-pick <sha-of-3.0-commit>`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
- #. ``git format-patch -1 <sha-of-3.3-commit>``
- #. ``git apply -3 <sha-of-3.3-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
+ #. ``git format-patch -1 <sha-of-3.11-commit>``
+ #. ``git apply -3 <sha-of-3.11-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the 3.11 applied patch into the forward merge commit)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``git format-patch -1 <sha-of-trunk-commit>``
#. ``git apply -3 <sha-of-trunk-commit>.patch`` (likely to have an issue with CHANGES.txt here: fix it ourselves, then git add CHANGES.txt)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
- #. ``git commit --amend``
+ #. ``git commit --amend`` (Notice this will squash the trunk applied patch into the forward merge commit)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
If the patch is for an older branch, and doesn't impact later branches (such as trunk), we still need to merge up.
On cassandra-3.0:
#. ``git cherry-pick <sha-of-3.0-commit>`` (if we have a problem b/c of CHANGES.txt not merging anymore, we fix it ourselves, in place)
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
-On cassandra-3.3:
+On cassandra-3.11:
#. ``git merge cassandra-3.0 -s ours``
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
On trunk:
- #. ``git merge cassandra-3.3 -s ours``
+ #. ``git merge cassandra-3.11 -s ours``
#. ``ant realclean && ant jar build-test`` (rebuild to make sure code compiles)
On any branch:
- #. ``git push origin cassandra-3.0 cassandra-3.3 trunk --atomic``
+ #. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
+
+.. tip::
+
+ A template for commit messages:
+
+ ::
+
+ <One sentence description, usually Jira title and CHANGES.txt summary>
+ <Optional lengthier description>
+
+ patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
+
+
+ Co-authored-by: Name1 <email1>
+ Co-authored-by: Name2 <email2>
Review comment:
```suggestion
Co-authored-by: Name1 <email1>
Co-authored-by: Name2 <email2>
```
(no idea if it will work with the leading space)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on a change in pull request #979: Fix How-to Commit docs
Posted by GitBox <gi...@apache.org>.
bereng commented on a change in pull request #979:
URL: https://github.com/apache/cassandra/pull/979#discussion_r620869757
##########
File path: doc/source/development/how_to_commit.rst
##########
@@ -84,6 +84,21 @@ On trunk:
On any branch:
#. ``git push origin cassandra-3.0 cassandra-3.11 trunk --atomic``
+.. tip::
+
+ A template for commit messages:
+
+ ::
+
+ <One sentence description, usually Jira title and CHANGES.txt summary>
Review comment:
added
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org