This is an automated email from the ASF dual-hosted git repository.
bernardobotella pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/cassandra-sidecar.git
The following commit(s) were added to refs/heads/trunk by this push:
new 84e909d0 CASSSIDECAR-227: Improved Documentation on IDE Integration
(#214)
84e909d0 is described below
commit 84e909d0c0b09ca8b7cf615ef1c8ddcf4ecd658d
Author: Yuriy Semchyshyn <[email protected]>
AuthorDate: Tue Apr 15 20:50:14 2025 -0500
CASSSIDECAR-227: Improved Documentation on IDE Integration (#214)
Patch by Yuriy Semchyshyn; Reviewed by Yifan Cai, Bernardo Botella for
CASSSIDECAR-227
---
CHANGES.txt | 1 +
CONTRIBUTING.md | 36 ++++++++++++++++++++----------------
2 files changed, 21 insertions(+), 16 deletions(-)
diff --git a/CHANGES.txt b/CHANGES.txt
index fa88b48c..f78a275c 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,5 +1,6 @@
0.2.0
-----
+ * Improved Documentation on IDE Integration (CASSSIDECAR-227)
* Schema Reporting Metrics Improvements (CASSSIDECAR-231)
* Add a Sidecar period task to monitor and delete commit log segments in the
cdc_raw directory (CASSSIDECAR-220)
* Fixing incorrect creation of MinuteBoundConfiguration &
MillisecondBoundConfiguration in CdcConfigImpl (CASSSIDECAR-236)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9e3accec..27138344 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -27,6 +27,7 @@ We warmly welcome and appreciate contributions from the
community.
* [How to Contribute](#how-to-contribute)
* [Discuss](#discuss)
* [Create a Ticket](#ticket)
+ * [Integration with IntelliJ IDEA](#idea)
* [Source Code Best Practices](#best-practices)
* [Introducing new APIs](#new-apis)
* [Asynchronous Programming](#async-programming)
@@ -38,7 +39,6 @@ We warmly welcome and appreciate contributions from the
community.
* [Future Composition](#future-composition)
* [Failure Handling](#failure-handling)
* [Cassandra Adapters](#cassandra-adapters)
-* [Source Code Style](#source-code-style)
## <a name="how-to-contribute"></a>How to Contribute
@@ -57,6 +57,25 @@ the origin of a feature, understand design decisions, and so
on.
When ready create a Jira ticket.
+### <a name="idea"></a>Integration with IntelliJ IDEA
+
+The project provides an
+[IntelliJ IDEA code formatting
configuration](https://github.com/apache/cassandra-sidecar/blob/trunk/ide/idea/codeStyleSettings.xml)
+that defines the source file coding standards.
+
+To import the formatting configuration run the following gradle task:
+
+```shell
+./gradlew idea
+```
+
+This will install the style settings into the `.idea` directory located at the
root of the project directory.
+
+You can then use the provided configuration that adheres to the project source
file coding standards.
+
+> **NOTE**: Opening a newly cloned repository in IDEA before running the
command above will result in the default code
+> format settings being used instead; if that is the case, delete
the `.idea` directory and start over.
+
## <a name="best-practices"></a>Source Code Best Practices
The Apache Cassandra Sidecar project uses the [vertx](https://vertx.io)
toolkit. It uses the asynchronous and
@@ -406,18 +425,3 @@ The `CassandraAdapterFactory` has a version tag which
represents the minimum ver
When adding shims, implement the minimum necessary changes in the new package
and name all classes with a version number after the word `Cassandra`.
For example, if `base`'s minimum version is moved to 5.0, a Cassandra40
adapter package/subproject should be added, with a minimum version of 4.0.0.
Within that project, the classes should all be named `Cassandra40*`, so
`Cassandra40Adapter`, `Cassandra40Factory`, etc.
-
-## <a name="source-code-style"></a>Source Code Style
-
-The project provides an
-[IntelliJ IDEA code formatting
configuration](https://github.com/apache/cassandra-sidecar/blob/trunk/ide/idea/codeStyleSettings.xml)
-that defines the source file coding standards.
-
-To import the formatting configuration run the following gradle task:
-
-```shell
-./gradlew idea
-```
-
-This will install the style settings into the `.idea` directory located at the
root of the project directory.
-You can then use the provided configuration that adheres to the project source
file coding standards.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
