Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
19 lines (12 loc) · 865 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (12 loc) · 865 Bytes

Contributing to RustFox

Thanks for your interest in contributing. This project is open source under the MIT License.

How to contribute

  • Bugs or feature requests: Open an issue.
  • Code or docs: Open a pull request. We’re happy to review and merge improvements.

Pull requests

  1. Fork the repo and create a branch from main.
  2. Make your changes. Keep the scope focused.
  3. Run locally: cargo fmt, cargo clippy -- -D warnings, cargo test.
  4. Push and open a PR against main. Describe what changed and why.

Documentation and README

  • When adding screenshots or GIFs to the README (or other docs), use descriptive alt text for the image. For example: ![RustFox Telegram chat showing tool use](screenshot.png). This helps accessibility and search discoverability.