Skip to content

Commit 7eae1cc

Browse files
committed
update contributing documentation
1 parent 610064f commit 7eae1cc

File tree

2 files changed

+36
-25
lines changed

2 files changed

+36
-25
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -147,16 +147,10 @@ softclient4es/
147147
│ │ └── client/ # Unit tests
148148
│ └── build.sbt
149149
150-
├── persistence/ # Akka persistence integration module
151-
│ ├── src/
152-
│ │ ├── main/scala/
153-
│ │ │ └── app/softnetwork/elastic/persistence/
154-
│ │ │ ├── query/ # Event Processor Stream
155-
│ │ │ └── typed/
156-
│ │ └── test/scala/
157-
│ │ └── app/softnetwork/elastic/
158-
│ │ └── client/ # Unit tests
159-
│ └── build.sbt
150+
├── documentation/ # Project documentation
151+
│ ├── client/
152+
│ ├── sql/
153+
│ └── best-practices.md
160154
161155
├── es6/jest/ # Jest Client (Elasticsearch 6.x)
162156
│ ├── src/
@@ -194,6 +188,33 @@ softclient4es/
194188
│ │ └── persistence/ # Java Client Persistence tests
195189
│ └── build.sbt
196190
191+
├── macros/ # SQL validation module
192+
│ └── src/
193+
│ └── main/scala/
194+
│ └── app/softnetwork/elastic/sq/macros
195+
196+
├── macros-tests/ # SQL validation tests
197+
│ └── test/
198+
│ └── main/scala/
199+
│ └── app/softnetwork/elastic/sq/macros
200+
201+
├── persistence/ # Akka persistence integration module
202+
│ ├── src/
203+
│ │ ├── main/scala/
204+
│ │ │ └── app/softnetwork/elastic/persistence/
205+
│ │ │ ├── query/ # Event Processor Stream
206+
│ │ │ └── typed/
207+
│ │ └── test/scala/
208+
│ │ └── app/softnetwork/elastic/
209+
│ │ └── client/ # Unit tests
210+
│ └── build.sbt
211+
212+
├── project/ # sbt build configuration
213+
│ ├── build.properties
214+
│ ├── plugins.sbt
215+
│ ├── SoftClient4es.scala
216+
│ └── Versions.scala
217+
197218
├── sql/ # SQL translation module
198219
│ ├── src/
199220
│ │ ├── main/scala/
@@ -212,17 +233,6 @@ softclient4es/
212233
│ │ └── scalatest/ # Testkit utilities
213234
│ └── build.sbt
214235
215-
├── documentation/ # Project documentation
216-
│ ├── client/
217-
│ ├── sql/
218-
│ └── best-practices.md
219-
220-
├── project/ # sbt build configuration
221-
│ ├── build.properties
222-
│ ├── plugins.sbt
223-
│ ├── SoftClient4es.scala
224-
│ └── Versions.scala
225-
226236
├── .scalafmt.conf # Scalafmt configuration
227237
├── .gitignore
228238
├── build.sbt # Root build configuration
@@ -238,7 +248,8 @@ softclient4es/
238248
|---------------|---------------------------------------------|-----------------------------------|
239249
| `sql` | SQL Parser | Gson |
240250
| `bridge` | SQL to Elasticsearch DSL translation | sql, Elastic4s |
241-
| `core` | Core abstractions, interfaces, and models | sql, Akka Streams, config |
251+
| `macros` | SQL Query type-safe validation | sql |
252+
| `core` | Core abstractions, interfaces, and models | macros, Akka Streams, config |
242253
| `persistence` | Akka persistence integration | core, Akka persistence |
243254
| `jest` | Elasticsearch 6.x client implementation | core, Jest client |
244255
| `rest` | Elasticsearch 7.x client implementation | core, REST High-Level client |
@@ -1130,8 +1141,8 @@ Thank you for contributing to SoftClient4ES! Your contributions help make this p
11301141

11311142
---
11321143

1133-
**Last Updated:** 2025-11-07
1134-
**Version:** 0.11.0
1144+
**Last Updated:** 2025-11-12
1145+
**Version:** 0.12.0
11351146

11361147
---
11371148

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ result match {
179179

180180
---
181181

182-
### **3. SQL compatible **
182+
### **3. SQL compatible**
183183

184184
### **3.1 SQL to Elasticsearch Query DSL**
185185

0 commit comments

Comments
 (0)