Hi Ruslan - Let me make a second pass on that workflow (Maxwell had a
couple suggestions too).
It's certainly not my intention to mandate branch names. :-) My intent
is to provide a reasonable "happy path" recommendation especially for
newcomers to the project. The branch naming recommendation comes from
https://cassandra.apache.org/_/development/patches.html (under "Creating
a Patch") ... I'll reword to indicate this is a recommendation or
suggestion.
SFAIK there is nothing process-wise that mandates a particular branch
naming structure, particularly for folks working in their own forked repo.
Thanks -- Joel.
On 8/25/2025 2:02 AM, Ruslan Fomkin wrote:
Hi Joel,
Thank you for bringing the question of improving CONTRIBUTING.md. I’ve
read the thread but not sure if there will be changes to the file.
Thus, I will mention that the following item caught my attention:
3) Create your feature branch, named with the JIRA id (CASSANDRA-12345)
This is currently not requires in the contribution file. It would be
nice to not have such strict requirement and allow contributors to
chose branch names in their forks in a way that work better for them.
I do find it useful to have the ticket number be present, but nothing
prevents from a typo there. In my case I have a short clue about the
ticket as a postfix to the number and to make my work more efficient I
use different structure for the prefix.
I hope the branch names still will not be mandated :)
Best regards,
Ruslan
On 16 Aug 2025, at 01:19, Joel Shepherd <sheph...@amazon.com> wrote:
I think CONTRIBUTING.md
<https://github.com/apache/cassandra/blob/b2037e473fb6438947d6ed9c58fbea5955cb72c4/CONTRIBUTING.md>
needs a tweak, but I want to make sure I have the story straight
before posting an edit.
Currently, it states "Apache Cassandra doesn't use GitHub pull
requests as part of the development process. In fact, this repository
is a GitHub mirror of the official repo
<https://gitbox.apache.org/repos/asf/cassandra.git>." Except the
"official repo" link points right back to the GitHub repo. :-)
Also, I'm not sure that the directions near the bottom of this page
-- https://cassandra.apache.org/_/development/patches.html -- to
"Attach the newly generated patch to the ticket/add a link to your
branch and click "Submit Patch" at the top of the ticket. This will
move the ticket into "Patch Available" status, indicating that your
submission is ready for review" are still applicable: at least I
haven't stumbled across the "Submit Patch" button/link yet.
My high-level understanding is:
1) Create a JIRA
2) Clone the repo
3) Create your feature branch, named with the JIRA id (CASSANDRA-12345)
4) Make, test, push, etc., your changes on your feature branch
5) When ready, create a PR in GitHub, and update the JIRA to indicate
the PR has been posted (comment + link)
If that's correct, I'm happy to go edit the documentation
appropriately (and with more polish than this email).
On the other hand, if I've tragically misunderstood then please
correct me here (and I'm still happy to update documentation as needed).
Thanks -- Joel.
