Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
53 lines (31 loc) 路 1.72 KB

CONTRIBUTING.md

File metadata and controls

53 lines (31 loc) 路 1.72 KB
Raw

Contribution Guidelines

Thank you for considering contributing to this project! Contributions are always welcome and appreciated.

How to Contribute

Please check the issue tracker to see if there is an issue you would like to work on or if it has already been resolved.

Reporting Bugs

  1. Open an issue on the issue tracker.
  2. Include information such as steps to reproduce the bug, expected behavior, and actual behavior.

Suggesting Features

  1. Open an issue on the issue tracker.
  2. Provide details about the feature, its purpose, and potential implementation ideas.

Submitting Pull Requests

  • Make sure all tests pass before submitting a pull request.
  • Write a clear description of the changes you made and the reasons behind them.

Important

Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in the work, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

Development Workflow

Important

If you're using an AI-assisted coding tool like Claude Code or Codex, make sure the AI follows the instructions in the AGENTS.md file.

Code Style

  • Use the make format command to format the code.

Running Tests

  • Use the make test command to run the tests.

Running Linters

  • Use the make lint command to run the linters.

See Available Commands

  • Run make help to see all available commands for managing different tasks.

Code of Conduct

We adhere to the Rust Code of Conduct.