Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ jobs:
retention-days: 30

- name: Upload to Codecov
if: env.CODECOV_TOKEN != ''
uses: codecov/codecov-action@v5
with:
files: lcov.info
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,10 @@ and builtin errors are surfaced directly as `Error` values.
- [ ] Stabilized Rust API
- [ ] ABI for FFI from C++/C#

## Minimum supported Rust version

Rust 1.90.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down
41 changes: 41 additions & 0 deletions docs/MAINTAINERS-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,47 @@ migration steps may be needed.

---

## Commit Conventions

This project uses [Conventional Commits](https://www.conventionalcommits.org/) with the
[Angular type extensions](https://github.com/angular/angular/blob/main/contributing-docs/commit-message-format.md).
Each commit message should have the form: `<type>(<scope>): <short summary>`.
The scope is optional but encouraged when it adds clarity.

**Types:**

| Type | Purpose |
|------|---------|
| `feat` | New feature (user-visible) |
| `fix` | Bug fix |
| `docs` | Documentation only |
| `style` | Formatting, whitespace (no logic change) |
| `refactor` | Code restructuring (no feature or fix) |
| `perf` | Performance improvement |
| `test` | Adding or updating tests |
| `build` | Build system or dependencies |
| `ci` | CI/CD configuration |
| `chore` | Maintenance (tooling, config, lint settings) |

Append `!` after the type/scope for breaking changes: `refactor!: ...` or `feat(eval)!: ...`.
(don't forget this requires a semver version bump)

Examples of scopes used in this project:

| Scope | When to use |
|-------|-------------|
| `deps` | Dependency updates (`build(deps)`, `ci(deps)`) |
| `fuzz` | Fuzzing infrastructure |
| `lint` | Clippy / lint configuration |
| `coverage` | Code coverage tooling |

Scopes are free-form — add new ones when they improve clarity (e.g., `feat(eval)`, `fix(scheme)`).

Only `feat` and `fix` are required by the spec; the rest are Angular conventions widely adopted in
practice. Use lowercase types, keep the summary concise and imperative ("add X", not "added X").

---

## Publishing a New Version to crates.io

The crate is published automatically by the [release workflow](../.github/workflows/release.yml)
Expand Down