Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (26 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 1.77 KB

Contributing to Vykar

Thanks for your interest in contributing!

How to contribute

  1. Open an issue first. Before writing any code, please open an issue describing the bug or feature. This lets us discuss the approach before you invest time on a PR.

  2. PRs require an approved issue. Pull requests are only accepted for issues that have been triaged and approved. If you open a PR without a corresponding issue, you'll be asked to create one first.

  3. Prefer detailed feature requests over PRs. A well-written feature request — with motivation, use cases, and expected behavior — is often more valuable than a code contribution. It helps us design the feature to fit the project's architecture and long-term direction.

AI-generated content

AI-assisted contributions are welcome, but they must meet the same quality bar as any other contribution: complete, tested, and ready to merge. Partial or rough drafts that need significant rework will be closed.

Development

cargo build --release
cargo test
make pre-commit          # fmt-check + clippy + doc-check + tests

Git hooks

This project uses prek for git hooks. Run prek install once after cloning to install them.

  • pre-commit: formatting, clippy, doc warnings, and file hygiene checks
  • pre-push: full test suite

Individual targets (fmt-check, lint, doc-check, test) remain available for ad-hoc use.

Nix users

If you use Nix with flakes, you can enter the development shell with:

nix develop

If you use direnv, add use flake to a local .envrc file for automatic shell activation.

See CLAUDE.md for the full project structure and architecture overview.