You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by "jcshepherd (via GitHub)" <gi...@apache.org> on 2025/08/21 17:45:35 UTC
[PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
jcshepherd opened a new pull request, #4327:
URL: https://github.com/apache/cassandra/pull/4327
Initial pass at fleshing out CONTRIBUTING.md to make it more welcoming for new contributors and provide pointers to basic development documentation. Planning on a second pass through website docs to clarify patch guidance from discussion thread: https://lists.apache.org/thread/5718pqmxzn5dwzswrlls75o2gtg1szf3
patch by jcshepherd, reviewed by TBD for https://issues.apache.org/jira/browse/CASSANDRA-20852
Thanks for sending a pull request! Here are some tips if you're new here:
* Ensure you have added or run the [appropriate tests](https://cassandra.apache.org/_/development/testing.html) for your PR.
* Be sure to keep the PR description updated to reflect all changes.
* Write your PR title to summarize what this PR proposes.
* If possible, provide a concise example to reproduce the issue for a faster review.
* Read our [contributor guidelines](https://cassandra.apache.org/_/development/index.html)
* If you're making a documentation change, see our [guide to documentation contribution](https://cassandra.apache.org/_/development/documentation.html)
Commit messages should follow the following format:
```
<One sentence description, usually Jira title or CHANGES.txt summary>
<Optional lengthier description (context on patch)>
patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
Co-authored-by: Name1 <email1>
Co-authored-by: Name2 <email2>
```
The [Cassandra Jira](https://issues.apache.org/jira/projects/CASSANDRA/issues/)
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2300013154
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,39 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements.
-# How to Contribute
+A recommended workflow to get started is:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Clone your fork into your development environment.
+4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
Review Comment:
```suggestion
4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. your-name/CASSANDRA-12345/base-branch .
```
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "jcshepherd (via GitHub)" <gi...@apache.org>.
jcshepherd commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2298872292
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,23 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements (both Python and Java). The basic workflow is the
Review Comment:
Good question. When I wrote that, I had things like nodetool and the utilities in the core package's tools/ directory in mind. I could mention, separately, these other ongoing projects as potential areas to contribute but want to respect the fact that they are somewhat separate initiatives from the core project.
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "Maxwell-Guo (via GitHub)" <gi...@apache.org>.
Maxwell-Guo commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2292780515
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,23 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements (both Python and Java). The basic workflow is the
+same for all:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Clone the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
Review Comment:
I think step 2 is to fork your own repo ?
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "jcshepherd (via GitHub)" <gi...@apache.org>.
jcshepherd commented on PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#issuecomment-3221680696
Revised per feedback.
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "jcshepherd (via GitHub)" <gi...@apache.org>.
jcshepherd commented on PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#issuecomment-3234228444
Commits squashed: thanks.
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "Maxwell-Guo (via GitHub)" <gi...@apache.org>.
Maxwell-Guo commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2292145171
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,23 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements (both Python and Java). The basic workflow is the
Review Comment:
tooling improvements means ? nodetool or cassandra drivers(python / go/ java) or tools like cassandra-dtest,cassandra-spark-connector or service like cassandra-analytics?
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,23 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements (both Python and Java). The basic workflow is the
+same for all:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Clone the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
+4. Make, build, test and self-review your changes on your feature branch.
+5. Submit the patch, either by attaching a patch file to your JIRA, creating a GitHub pull request, or posting a
Review Comment:
it seems that ”attaching a patch file to your JIRA“ has not been used for a long time. @michaelsembwever am i right ?
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2300037563
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,39 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements.
-# How to Contribute
+A recommended workflow to get started is:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Clone your fork into your development environment.
+4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
Review Comment:
the reasoning for the `your-name/` prefix is it helps teams work together (e.g. when needing to rebase dev branches). it's also nice to see branches in a shared fork sorted first by owner (and makes cleaning up old stale branches easier).
the reasoning for the `/base-branch` suffix is when patches differ across baselines and need separate branches. we still want these categorised by owner and then ticket.
--
another time, `build/sh/development-switch.sh` could be improved.
its `--jira` flag could be renamed to `--branch` (as it has actually nothing to do with a jira, just the branch name). (e.g. you don't have to first have a jira to create a dev branch)
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic closed pull request #4327: Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852).
URL: https://github.com/apache/cassandra/pull/4327
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "jcshepherd (via GitHub)" <gi...@apache.org>.
jcshepherd commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2305155121
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,39 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements.
-# How to Contribute
+A recommended workflow to get started is:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Clone your fork into your development environment.
+4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
Review Comment:
Thanks Mick: please take a look at the latest revision and let me know what you think.
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2300037563
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,39 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements.
-# How to Contribute
+A recommended workflow to get started is:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Clone your fork into your development environment.
+4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
Review Comment:
the reasoning for the `your-name/` prefix is it helps teams work together (e.g. when needing to rebase dev branches). it's also nice to see branches in a shared fork sorted first by owner (and makes cleaning up old stale branches easier).
the reasoning for the `/base-branch` suffix is when patches differ across baselines and need separate branches. we still want these categorised by owner and then ticket.
--
another time, `build/sh/development-switch.sh` could be improved.
it's `--jira` flag could be renamed to `--branch` (as it has actually nothing to do with a jira, just the branch name). (e.g. you don't have to first have a jira to create a dev branch)
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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
Re: [PR] Improving CONTRIBUTING.md for new contributors (CASSANDRA-20852). [cassandra]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #4327:
URL: https://github.com/apache/cassandra/pull/4327#discussion_r2300037563
##########
CONTRIBUTING.md:
##########
@@ -18,16 +18,39 @@
#
-->
-# Apache Cassandra and Pull Requests
+# How to Contribute
-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).
+There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements,
+bug fixes, changes to the Java code base, and tooling improvements.
-# How to Contribute
+A recommended workflow to get started is:
+1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do.
+2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra).
+3. Clone your fork into your development environment.
+4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 .
Review Comment:
another time, `build/sh/development-switch.sh` could be improved.
it's `--jira` flag could be renamed to `--branch` (as it has actually nothing to do with a jira, just the branch name). (e.g. you don't have to first have a jira to create a dev branch)
the reasoning for the `your-name/` prefix is it helps teams work together (e.g. when needing to rebase dev branches). it's also nice to see branches in a shared fork sorted first by owner (and makes cleaning up old stale branches easier).
the reasoning for the `/base-branch` suffix is when patches differ across baselines and need separate branches. we still want these categorised by owner and then ticket.
--
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.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
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