mirror of
https://github.com/getnora-io/nora.git
synced 2026-04-12 06:50:31 +00:00
chore: DX improvements — typos, blame-ignore, PR template, registry checklist (#120)
* chore: add workspace clippy lints, release profiles, COMPAT.md, diff-registry.sh - Workspace clippy lints: or_fun_call, redundant_clone, collection_is_never_read, naive_bytecount, stable_sort_primitive, large_types_passed_by_value, assigning_clones - Fix or_fun_call in cargo_registry.rs (unwrap_or -> unwrap_or_else) - Release profiles: release (thin LTO) + release-official (full LTO, codegen-units=1) - COMPAT.md: protocol compatibility matrix for all 7 registries (40 endpoints) - scripts/diff-registry.sh: differential smoke tests (Docker/npm/Cargo/PyPI/Go/Raw) * ci: add typos spell-check job and config * chore: add .git-blame-ignore-revs for bulk fmt/clippy commits * chore: unify PR template with What/Why/Checklist format * docs: add new registry checklist and improve contributing guide * fix: correct typos action SHA to v1.45.0
This commit is contained in:
@@ -107,16 +107,19 @@ All three must pass. CI will enforce this.
|
||||
|
||||
- Run `cargo fmt` before committing
|
||||
- Fix all `cargo clippy` warnings
|
||||
- No `unwrap()` in production code (use proper error handling)
|
||||
- Follow Rust naming conventions
|
||||
- Keep functions short and focused
|
||||
- Add tests for new functionality
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. Update CHANGELOG.md if the change is user-facing
|
||||
2. Add tests for new features or bug fixes
|
||||
3. Ensure CI passes (fmt, clippy, test, security checks)
|
||||
4. Keep PRs focused — one feature or fix per PR
|
||||
1. Branch from `main`, use descriptive branch names (`feat/`, `fix/`, `chore/`)
|
||||
2. Update CHANGELOG.md if the change is user-facing
|
||||
3. Add tests for new features or bug fixes
|
||||
4. Ensure CI passes (fmt, clippy, test, security checks)
|
||||
5. Keep PRs focused — one feature or fix per PR
|
||||
6. PRs are squash-merged to keep a clean history
|
||||
|
||||
## Commit Messages
|
||||
|
||||
@@ -131,6 +134,20 @@ Use conventional commits:
|
||||
|
||||
Example: `feat: add npm scoped package support`
|
||||
|
||||
## New Registry Checklist
|
||||
|
||||
When adding a new registry type (Docker, npm, Maven, etc.), ensure all of the following:
|
||||
|
||||
- [ ] Handler in `nora-registry/src/registry/`
|
||||
- [ ] Health check endpoint
|
||||
- [ ] Metrics (Prometheus)
|
||||
- [ ] OpenAPI spec update
|
||||
- [ ] Startup log line
|
||||
- [ ] Dashboard UI tile
|
||||
- [ ] Playwright e2e test
|
||||
- [ ] CHANGELOG entry
|
||||
- [ ] COMPAT.md update
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
- Use GitHub Issues with the provided templates
|
||||
|
||||
Reference in New Issue
Block a user