Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (19 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.15 KB

Contributing to docdiff

Thank you for your interest in contributing! docdiff is an open-source CLI tool for comparing two files using document distance algorithms. We welcome contributions from everyone.

How to Contribute

  • Fork the repository and create your branch from main.
  • Write clear, well-documented Rust code and tests.
  • Follow the architecture and algorithm guidelines in the README.
  • Submit a pull request with a clear description of your changes, especially if you improve or add new document distance algorithms.

Code Style

  • Use Rust 2024 edition conventions.
  • Document public APIs, modules, and algorithms.
  • Write automated tests for new features, bug fixes, and algorithm correctness.

Reporting Issues

  • Use GitHub Issues for bugs, feature requests, and questions.
  • When reporting issues, provide as much detail as possible (steps to reproduce, environment, CLI command used, input files, etc).

Community

  • Be respectful and inclusive (see CODE_OF_CONDUCT.md).
  • Join discussions, share ideas for new algorithms, and help others.

License

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