Skip to content

Commit b738880

Browse files
committed
docs: update documentation
1 parent 488c269 commit b738880

2 files changed

Lines changed: 7 additions & 38 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ Run `mvn checkstyle:check` locally before pushing.
4949
3. Handle it in `AbstractSqlDialect` (and dialect subclasses if behaviour differs)
5050
4. Add tests for all three layers
5151

52+
## Adding Tests
53+
54+
- Add JUnit tests under `src/test/java/com/github/ezframework/javaquerybuilder/query/` and its subpackages.
55+
- Focus on covering all core features, edge cases, and error handling.
56+
5257
## Releasing
5358

5459
Releases are published to **GitHub Packages** and available via **JitPack** automatically:

README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
![CI](https://github.com/EzFramework/JavaQueryBuilder/actions/workflows/ci.yml/badge.svg)
44

5-
This project uses GitHub Actions for continuous integration. See `.github/workflows/ci.yml` for details.
6-
7-
A lightweight, fluent Java library for building SQL queries and filtering in-memory data — no runtime dependencies required.
5+
A lightweight, fluent Java library for building SQL queries and filtering in-memory data, no runtime dependencies required.
86

97
## Features
108

@@ -154,40 +152,6 @@ SQLite wraps every table and column name in double quotes, which safely handles
154152
`LIKE` values are automatically wrapped with `%` on both sides so `whereLike("name", "alice")` becomes `name LIKE ?` with parameter `%alice%`.
155153

156154

157-
158-
## Project Layout
159-
160-
```
161-
src/main/java/com/skyblockexp/ezframework/query/
162-
├── QueryBuilder.java Fluent builder — start here
163-
├── Query.java Query data model; delegates rendering to SqlDialect
164-
├── SqlResult.java Holds the generated SQL string and parameter list
165-
├── SqlDialect.java Strategy interface (STANDARD / SQLITE constants)
166-
├── AbstractSqlDialect.java Shared rendering logic — extend to add new dialects
167-
├── StandardSqlDialect.java Standard SQL (no quoting)
168-
├── SqliteDialect.java SQLite (double-quote identifiers, boolean → 0/1)
169-
├── Condition.java Single field condition (operator + value)
170-
├── Operator.java Enum of supported operators
171-
└── QueryableStorage.java Interface for in-memory query execution
172-
```
173-
174155
## License
175156

176-
MIT
177-
178-
## Test Coverage
179-
180-
This project uses [JaCoCo](https://www.jacoco.org/jacoco/) for test coverage analysis.
181-
182-
### How to Generate Coverage Report
183-
184-
1. Run all tests and generate the coverage report:
185-
```sh
186-
mvn test jacoco:report
187-
```
188-
2. Open the HTML report:
189-
- Open `target/site/jacoco/index.html` in your browser to view detailed coverage metrics.
190-
191-
## Adding Tests
192-
- Add JUnit tests under `src/test/java/com/github/ezframework/javaquerybuilder/query/` and its subpackages.
193-
- Focus on covering all core features, edge cases, and error handling.
157+
MIT

0 commit comments

Comments
 (0)