You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by ab...@apache.org on 2026/03/25 19:45:29 UTC
(cassandra-nodejs-driver) branch post-donation-doc-update created (now 8d3fc75f)
This is an automated email from the ASF dual-hosted git repository.
absurdfarce pushed a change to branch post-donation-doc-update
in repository https://gitbox.apache.org/repos/asf/cassandra-nodejs-driver.git
at 8d3fc75f CASSNODEJS-2 Update CONTRIBUTING.md after ASF donation
This branch includes the following new commits:
new 8d3fc75f CASSNODEJS-2 Update CONTRIBUTING.md after ASF donation
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org
(cassandra-nodejs-driver) 01/01: CASSNODEJS-2 Update CONTRIBUTING.md after ASF donation
Posted by ab...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
absurdfarce pushed a commit to branch post-donation-doc-update
in repository https://gitbox.apache.org/repos/asf/cassandra-nodejs-driver.git
commit 8d3fc75fc169eeb9d6e3ff791ed13bfa59af8f4a
Author: janehe <ja...@datastax.com>
AuthorDate: Tue Feb 3 12:55:33 2026 -0800
CASSNODEJS-2 Update CONTRIBUTING.md after ASF donation
patch by Jane He; reviewed; reviewed by Jorge Bay Gondra and Bret McGuire
---
CONTRIBUTING.md | 85 +++++++++++++++++++++++++++++++++++++++++++++
README.md | 28 ++++++++++-----
doc/upgrade-guide/README.md | 2 +-
docs.yaml | 2 +-
examples/README.md | 2 +-
package-lock.json | 2 +-
package.json | 6 ++--
7 files changed, 111 insertions(+), 16 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..45a79d45
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,85 @@
+# Contributing
+
+Thank you for your interest in contributing to the Apache Cassandra Node.js Driver! This repository is now part of the Apache Software Foundation (ASF) and follows Apache contribution practices.
+
+## Ways to Contribute
+
+There are many ways to contribute, including:
+
+- **Bug Reports**: Identify incorrect behavior, inconsistencies, or regressions in the driver. Provide reproduction steps when possible.
+- **Feature Requests**: Propose improvements or new functionality. Please describe the use case (not just a proposed API).
+- **Documentation Improvements**: Enhance guides, examples, javadocs, or configuration explanations.
+- **Pull Requests**: Submit fixes, enhancements, performance improvements, or refactorings.
+- **Testing Contributions**: Add missing tests, improve coverage, or enhance test infrastructure.
+- **Support & Triage**: Help evaluate reported issues or contribute to discussions.
+- **Verify Releases**: Verify the release artifacts work correctly in your environment, when a release is proposed in the mailing list.
+
+### Communication
+1. **Mailing List**:
+ - https://lists.apache.org/list.html?dev@cassandra.apache.org
+2. **JIRA**:
+ - https://issues.apache.org/jira/projects/CASSNODEJS
+ - Older issues before the donation can be found at:
+ - https://datastax-oss.atlassian.net/projects/NODEJS
+3. **GitHub Repository**: https://github.com/apache/cassandra-nodejs-driver
+4. **Slack**: #cassandar-drivers channel, in the Apache Software Foundation [Slack](https://infra.apache.org/slack.html).
+Ask in the mailing list for an invite to the Slack workspace.
+
+## Submitting changes
+
+### Submitting Changes (Pull Requests)
+
+All code changes require:
+
+1. **A corresponding JIRA ticket**
+ Include the JIRA key in the PR title, e.g.:
+ `NODEJS-696: Migrate Travis CI to Github Action`
+
+2. **A pull request on GitHub**
+ Repository: <https://github.com/apache/cassandra-nodejs-driver>
+
+3. **Tests**
+ Every fix or feature should include or update tests. PRs without tests are rarely accepted.
+
+4. **Documentation updates**
+ Update manual, javadocs, examples, or reference docs when applicable.
+
+5. **Passing CI**
+ PRs must pass all CI jobs unless reviewers explicitly allow exceptions.
+
+6. **Code Review**
+ All PRs require at least two approvals from Apache committers before merging.
+
+7. **Squash after review**
+ After committers' approvals and before merging, please squash commits into one, with a commit message in the following format:
+ ```
+ NODEJS-696: Migrate Travis CI to Github Action
+ patch by Jane He; reviewed by Abe Ratnofsky and Bret McGuire for NODEJS-696
+ ```
+
+## Development Setup
+
+### Prerequisites
+- Node.js v20 or later
+- npm
+
+### Running Tests Locally
+1. Install Cassandra Cluster Manager (CCM) following its [README](https://github.com/apache/cassandra-ccm).
+2. On MacOS only, enable loopback aliases:
+
+```shell
+for i in {2..255}; do sudo ifconfig lo0 alias 127.0.0.$i up; done
+```
+Note: This may slow down networking. To remove the aliases after testing:
+```shell
+for i in {2..255}; do sudo ifconfig lo0 -alias 127.0.0.$i up; done
+```
+
+3. Install project dependencies: `npm install`
+4. Run the tests: `npx mocha test/unit test/integration/short --recursive --exit`.
+You can specify the Cassandra version by the `CCM_VERSION` environment variable, e.g.:
+`CCM_VERSION=5.0.2 npx mocha test/unit test/integration/short --recursive --exit`.
+
+## License and CLA
+
+All contributions are made under the Apache License, Version 2.0. The ASF requires a signed Contributor License Agreement (CLA) for non-trivial contributions.
diff --git a/README.md b/README.md
index 8208c8b0..53855819 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
# Node.js Driver for Apache Cassandra®
-A modern, [feature-rich](#features) and highly tunable Node.js client library for Apache Cassandra and [DSE][dse] using
-exclusively Cassandra's binary protocol and Cassandra Query Language.
+A modern, [feature-rich](#features) and highly tunable Node.js client library for Apache Cassandra, [DSE][dse], [HCD][hcd], and [Astra DB][astra] using exclusively Cassandra's binary protocol and Cassandra Query Language.
## Installation
@@ -34,9 +33,19 @@ $ npm install cassandra-driver
- [API docs][doc-api]
- [FAQ][faq]
-## Getting Help
+## Contribution and Communication
-You can use the [project mailing list][mailinglist] or create a ticket on the [Jira issue tracker][jira].
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to the project.
+
+1. **Mailing List**:
+ - https://lists.apache.org/list.html?dev@cassandra.apache.org
+2. **JIRA**:
+ - https://issues.apache.org/jira/projects/CASSNODEJS
+ - Older issues before the donation can be found at:
+ - https://datastax-oss.atlassian.net/projects/NODEJS
+3. **GitHub Repository**: https://github.com/apache/cassandra-nodejs-driver
+4. **Slack**: #cassandar-drivers channel, in the Apache Software Foundation [Slack](https://infra.apache.org/slack.html).
+Ask in the mailing list for an invite to the Slack workspace.
## Basic usage
@@ -250,7 +259,7 @@ The current version of the driver offers support consistent with this policy for
- Apache Cassandra versions 3.0 and above.
- DataStax Enterprise versions 5.1 and 6.8.
-- Node.js versions 18.x, 20.x, and 22.x.
+- Node.js versions 20.x, 22.x, and 24.x.
Note: DataStax products do not support big-endian systems.
@@ -260,6 +269,8 @@ This driver is based on the original work of [Jorge Bay][jorgebay] on [node-cass
The development effort to provide an up to date, high performance, fully featured Node.js Driver for Apache Cassandra will continue on this project, while [node-cassandra-cql][old-driver] will be discontinued.
+This project is donated to the Apache Software Foundation and is now maintained under the Apache Cassandra project.
+
## License
Copyright 2013 The Apache Software Foundation
@@ -291,9 +302,8 @@ Unless required by applicable law or agreed to in writing, software distributed
[project documentation]: https://github.com/nodejs/release#release-schedule
[jorgebay]: https://github.com/jorgebay
[drivers]: https://github.com/datastax
-[mailinglist]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/nodejs-driver-user
-[jira]: https://datastax-oss.atlassian.net/projects/NODEJS/issues
[streams2]: https://nodejs.org/api/stream.html#stream_class_stream_readable
[cql-udt]: https://cassandra.apache.org/doc/latest/cql/types.html#udts
-[dse]: https://www.datastax.com/products/datastax-enterprise
-[astra]: https://www.datastax.com/products/datastax-astra
+[dse]: https://docs.datastax.com/en/dse/6.9/get-started/get-started-dse.html
+[hcd]: https://docs.datastax.com/en/hyper-converged-database/1.2/get-started/hcd-introduction.html
+[astra]: https://docs.datastax.com/en/astra-db-serverless/index.html
diff --git a/doc/upgrade-guide/README.md b/doc/upgrade-guide/README.md
index ef0c02aa..099cb691 100644
--- a/doc/upgrade-guide/README.md
+++ b/doc/upgrade-guide/README.md
@@ -137,5 +137,5 @@ The following is a list of changes made in version 2.0 of the driver that are re
1. `inet` values are decoded as `InetAddress` instances.
-[mailing-list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/nodejs-driver-user
+[mailing-list]: https://lists.apache.org/list.html?dev@cassandra.apache.org
[op-info]: https://docs.datastax.com/en/developer/nodejs-driver/latest/api/module.policies/module.retry/type.OperationInfo/
\ No newline at end of file
diff --git a/docs.yaml b/docs.yaml
index a3fea7e0..7233139b 100644
--- a/docs.yaml
+++ b/docs.yaml
@@ -34,7 +34,7 @@ links:
- title: Issues
href: https://datastax-oss.atlassian.net/projects/NODEJS/issues
- title: Mailing List
- href: https://groups.google.com/a/lists.datastax.com/forum/#!forum/nodejs-driver-user
+ href: https://lists.apache.org/list.html?dev@cassandra.apache.org
- title: Npm
href: https://www.npmjs.org/package/cassandra-driver
versions:
diff --git a/examples/README.md b/examples/README.md
index 6859bf4e..eabd47ba 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -36,5 +36,5 @@ If you have any questions regarding these examples, feel free to post your quest
[dse]: https://www.datastax.com/products/datastax-enterprise
[doc-index]: https://docs.datastax.com/en/developer/nodejs-driver/latest/
-[mailing-list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/nodejs-driver-user
+[mailing-list]: https://lists.apache.org/list.html?dev@cassandra.apache.org
[faq]: https://docs.datastax.com/en/developer/nodejs-driver/latest/faq/
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index bd218cdb..67c1b268 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -23,7 +23,7 @@
"temp": ">= 0.8.3"
},
"engines": {
- "node": ">=18"
+ "node": ">=20"
}
},
"node_modules/@sinonjs/commons": {
diff --git a/package.json b/package.json
index 9ae90276..c2f1bd50 100644
--- a/package.json
+++ b/package.json
@@ -35,10 +35,10 @@
},
"repository": {
"type": "git",
- "url": "https://github.com/datastax/nodejs-driver.git"
+ "url": "https://github.com/apache/cassandra-nodejs-driver.git"
},
"bugs": {
- "url": "https://groups.google.com/a/lists.datastax.com/forum/#!forum/nodejs-driver-user"
+ "url": "https://issues.apache.org/jira/projects/CASSNODEJS/issues"
},
"scripts": {
"test": "./node_modules/.bin/mocha test/unit -R spec -t 5000 --recursive",
@@ -52,6 +52,6 @@
"eslint": "eslint lib test"
},
"engines": {
- "node": ">=18"
+ "node": ">=20"
}
}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org