Skip to content

Commit af65141

Browse files
committed
docs: update dev workflow guidance
1 parent e4f66fb commit af65141

File tree

2 files changed

+44
-52
lines changed

2 files changed

+44
-52
lines changed

.serena/memories/suggested_commands.md

Lines changed: 28 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,71 +4,62 @@
44

55
## Setup & Environment
66
```bash
7-
make setup # One-time development environment setup (installs tools, fetches deps)
8-
mise trust && mise install # Alternative: manual tool installation via mise
7+
mise trust && mise install # One-time tool installation via mise
8+
cargo fetch # Fetch dependencies
99
```
1010

1111
## Running the Engine
1212
```bash
13-
make dev # Start dev server with auto-reload (cargo watch)
14-
make run # Run engine in debug mode
15-
cargo run --bin inferadb-engine # Direct cargo command
13+
cargo run --bin inferadb-engine # Run engine in debug mode
14+
cargo watch -x 'run --bin inferadb-engine' # Dev server with auto-reload
1615
```
1716

1817
## Building
1918
```bash
20-
make build # Debug build
21-
make release # Release build (optimized)
22-
cargo build --release --workspace # Direct cargo command
19+
cargo build # Debug build
20+
cargo build --release # Release build (optimized)
2321
```
2422

2523
## Testing
2624
```bash
27-
make test # Run unit tests (cargo nextest)
28-
make test-integration # Run integration tests
29-
make test-fdb # Run FoundationDB integration tests (requires Docker)
30-
make test-aws # Run AWS Secrets Manager tests (requires Docker)
31-
make test-gcp # Run GCP Secret Manager tests (requires Docker)
32-
make test-azure # Run Azure Key Vault tests (requires Docker)
33-
make coverage # Generate code coverage report
25+
cargo nextest run --lib --workspace # Run unit tests
26+
cargo nextest run --test '*' --workspace # Run integration tests
27+
cargo test --doc --all-features # Run doc tests
28+
./docker/fdb-integration-tests/test.sh # FoundationDB integration tests
29+
./docker/aws-integration-tests/test.sh # AWS Secrets Manager tests
30+
./docker/gcp-integration-tests/test.sh # GCP Secret Manager tests
31+
./docker/azure-integration-tests/test.sh # Azure Key Vault tests
32+
cargo llvm-cov --workspace --html # Generate code coverage report
3433
```
3534

3635
## Code Quality
3736
```bash
38-
make check # Run all quality checks (format, lint, audit)
39-
make format # Format code (cargo +nightly fmt)
40-
make lint # Run clippy linter
41-
make audit # Run security audit
42-
make deny # Check dependencies with cargo-deny
43-
make fix # Auto-fix clippy warnings
37+
cargo +nightly fmt --all # Format code
38+
cargo clippy --workspace --all-targets -- -D warnings # Lint
39+
cargo audit # Security audit
40+
cargo deny check # Dependency checks
41+
cargo clippy --fix --allow-dirty --allow-staged # Auto-fix warnings
4442
```
4543

4644
## Benchmarks & Analysis
4745
```bash
48-
make bench # Run benchmarks
49-
make doc # Generate documentation
50-
make tree # Show dependency tree
51-
make outdated # Check for outdated dependencies
52-
make bloat # Analyze binary size (requires cargo-bloat)
46+
cargo bench --workspace # Run benchmarks
47+
cargo doc --workspace --no-deps # Generate documentation
48+
cargo tree --workspace # Show dependency tree
49+
cargo update --workspace --dry-run # Check for outdated deps
5350
```
5451

5552
## Docker & Kubernetes
5653
```bash
57-
make docker-build # Build Docker image
58-
make docker-run # Run Docker container
59-
make k8s-deploy # Deploy to local Kubernetes
60-
make k8s-delete # Delete from Kubernetes
54+
docker build -t inferadb-engine:dev . # Build Docker image
55+
docker run -p 8080:8080 -p 8081:8081 inferadb-engine:dev # Run container
56+
kubectl apply -k k8s/ # Deploy to Kubernetes
57+
kubectl delete -k k8s/ # Delete from Kubernetes
6158
```
6259

6360
## Cleanup
6461
```bash
65-
make clean # Clean build artifacts
66-
make reset # Full reset of dev environment (Docker, cargo, etc.)
67-
```
68-
69-
## CI Simulation
70-
```bash
71-
make ci # Simulate full CI pipeline locally
62+
cargo clean # Clean build artifacts
7263
```
7364

7465
## Unix Utilities (Darwin/macOS)

.serena/memories/task_completion.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,38 @@ When completing a task, run these commands to verify quality:
44

55
## Minimum Required Checks
66
```bash
7-
make check
7+
cargo +nightly fmt --all # Format code
8+
cargo clippy --workspace --all-targets -- -D warnings # Lint
9+
cargo audit # Security audit
810
```
9-
This runs:
10-
1. `make format` - Format code with `cargo +nightly fmt --all`
11-
2. `make lint` - Run `cargo clippy --workspace --all-targets -- -D warnings`
12-
3. `make audit` - Run `cargo audit` for security vulnerabilities
1311

1412
## For Code Changes
1513
```bash
16-
make test # Run unit tests
17-
make test-integration # Run integration tests (if applicable)
14+
cargo nextest run --lib --workspace # Run unit tests
15+
cargo nextest run --test '*' --workspace # Run integration tests (if applicable)
1816
```
1917

2018
## Full CI Simulation (Before Push)
2119
```bash
22-
make ci
20+
cargo +nightly fmt --all
21+
cargo clippy --workspace --all-targets -- -D warnings
22+
cargo nextest run --lib --workspace
23+
cargo audit
24+
cargo deny check
2325
```
24-
This runs: `check`, `test`, and `deny` in sequence.
2526

2627
## Additional Checks (As Needed)
27-
- `make test-fdb` - If changes affect FoundationDB storage
28-
- `make coverage` - If adding new code paths
29-
- `make bench` - If performance-sensitive changes
30-
- `make deny` - Check for dependency issues
28+
- `./docker/fdb-integration-tests/test.sh` - If changes affect FoundationDB storage
29+
- `cargo llvm-cov --workspace --html` - If adding new code paths
30+
- `cargo bench` - If performance-sensitive changes
31+
- `cargo deny check` - Check for dependency issues
3132

3233
## Documentation Updates
3334
- Update relevant docs in `docs/` if behavior changes
3435
- Update doc comments for API changes
35-
- Run `make doc` to verify documentation builds
36+
- Run `cargo doc --workspace --no-deps` to verify documentation builds
3637

3738
## Commit Guidelines
38-
- Run `make check` before committing
39+
- Run format and lint before committing
3940
- Use conventional commit format: `type: subject`
4041
- Keep commits focused and atomic

0 commit comments

Comments
 (0)