Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.25 KB

Contributing to ResExt

Thanks for your interest in contributing!

Quick Start

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Run tests: cargo test
  5. Run clippy: cargo clippy -- -D warnings
  6. Format code: cargo fmt
  7. Commit: git commit -m "Add feature X"
  8. Push: git push origin feature/your-feature
  9. Open a Pull Request

Guidelines

Code Style

  • Follow Rust standard style (enforced by cargo fmt with config in the project's root dir)
  • Run cargo clippy and fix all warnings
  • Add tests for new features
  • Document public APIs with /// comments

Commit Messages

  • Be descriptive: "Add new method for..." not "Update code"
  • Reference issues: "Fix #123: Handle empty context messages"

Pull Requests

  • Keep PRs focused (one feature/fix per PR)
  • Include tests for new functionality
  • Update README if adding user-facing features
  • Describe what changed and why

Reporting Issues

  • Check existing issues first
  • Provide minimal reproduction case
  • Use markdown code blocks for code/errors

Questions?

Open an issue or discussion. We're happy to help!

License

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