Ferrit Explore
中文·繁體·EN·日本語 Sign in Register
cielxl / veld / CONTRIBUTING.md
# Contributing to veld

Thanks for your interest in contributing! This document covers how to build, test, and
submit changes.

## Getting started

1. Install a recent stable Rust toolchain via [rustup](https://rustup.rs) (edition 2021,
   Rust 1.75+).
2. Fork and clone the repository.
3. Build and run the test suite:

   ```bash
   cargo build
   cargo test
   ```

## Before you open a pull request

Please make sure the following all pass locally — CI runs the same checks:

```bash
cargo fmt --all -- --check     # formatting
cargo clippy --all-targets -- -D warnings   # lints
cargo test --all-targets       # tests
```

## Guidelines

- Keep pull requests focused; one logical change per PR.
- Match the style of the surrounding code.
- Add or update tests for behavior changes.
- Update the relevant docs (`README.md`, `docs/`) when you change user-facing behavior.
- Describe what and why in the PR description.

## Trademark / scope

veld is a clean-room reimplementation. **Do not** copy source code, comments, or other
copyrightable text from nginx or any other project into this codebase. Independent
implementations of ideas, algorithms, protocols, and configuration syntax are welcome;
verbatim copying is not.

## Reporting bugs and requesting features

Use GitHub Issues. For security vulnerabilities, follow [SECURITY.md](SECURITY.md)
instead of opening a public issue.

## License

By contributing, you agree that your contributions will be licensed under the project's
[MIT License](LICENSE).