docs: add CI expectations to CLAUDE.md and README.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
15
CLAUDE.md
15
CLAUDE.md
@@ -103,6 +103,21 @@ cargo test # run all tests
|
|||||||
cargo clippy --workspace # lint
|
cargo clippy --workspace # lint
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## CI
|
||||||
|
|
||||||
|
Gitea Actions runs on every push to any branch. All three checks must
|
||||||
|
pass before merging:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo fmt --check --all # formatting
|
||||||
|
cargo clippy --workspace -- -D warnings # lint (warnings are errors)
|
||||||
|
cargo test --workspace # tests
|
||||||
|
```
|
||||||
|
|
||||||
|
Run these locally before pushing. `cargo fmt --all` fixes formatting
|
||||||
|
automatically. Clippy warnings must be resolved, not suppressed with
|
||||||
|
`#[allow(...)]` unless there is a clear rationale.
|
||||||
|
|
||||||
## Environment
|
## Environment
|
||||||
|
|
||||||
- Targets Fedora 43 (systemd, SELinux enforcing)
|
- Targets Fedora 43 (systemd, SELinux enforcing)
|
||||||
|
|||||||
13
README.md
13
README.md
@@ -120,6 +120,19 @@ pinned = ["your-org/embedding-model"]
|
|||||||
cargo build --release
|
cargo build --release
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## CI
|
||||||
|
|
||||||
|
Every push triggers format, lint, and test checks. Ensure these pass
|
||||||
|
locally before pushing:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo fmt --check --all # must be clean
|
||||||
|
cargo clippy --workspace -- -D warnings # warnings are errors
|
||||||
|
cargo test --workspace # all tests must pass
|
||||||
|
```
|
||||||
|
|
||||||
|
Tagged releases (`v*`) additionally build an SRPM and publish to COPR.
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
|||||||
Reference in New Issue
Block a user