Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (50 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 1.77 KB
Raw

Contributing to dakera-cli

Thank you for your interest in contributing to dakera-cli.

Development Setup

Prerequisites

  • Rust 1.75 or later (stable toolchain)
  • A running Dakera server for integration testing

Building

git clone https://github.com/dakera-ai/dakera-cli.git
cd dakera-cli
cargo build

Running

# Run the CLI directly
cargo run -- health

# Or install locally
cargo install --path .
dk health

Testing

cargo test

Code Quality

# Format code
cargo fmt

# Run linter
cargo clippy -- -D warnings

# Check compilation
cargo check

Pull Request Process

  1. Fork the repository and create a feature branch from main.
  2. Ensure your code compiles without warnings (cargo clippy -- -D warnings).
  3. Format your code with cargo fmt.
  4. Add or update tests as appropriate.
  5. Update CHANGELOG.md with a description of your changes.
  6. Open a pull request with a clear description of your changes.

Reporting Issues

Use the Bug Report template to report bugs. Please include:

  • Steps to reproduce the issue
  • Expected vs actual behavior
  • dk --version output, operating system, and Rust version

Have a feature idea? Use the Feature Request template.

Security Vulnerabilities

Do not open public issues for security vulnerabilities. See SECURITY.md for responsible disclosure instructions — report via GitHub Security Advisories.

License

By contributing, you agree that your contributions will be licensed under the MIT License.