Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.41 KB

Contributing to Replicheck

Thank you for your interest in contributing to Replicheck! We welcome contributions of all kinds, including bug reports, feature requests, code, and documentation improvements.

How to Contribute

  1. Fork the repository and create your branch from main.
  2. Write clear, concise commit messages.
  3. Add tests for new features or bug fixes when possible.
  4. Ensure code style by running black . before submitting.
  5. Run all tests with pytest to make sure nothing is broken.
  6. Open a pull request with a clear description of your changes and why they are needed.

Code Style

  • Use Black for code formatting.
  • Follow PEP8 guidelines.

Reporting Issues

If you find a bug or have a feature request, please open an issue. Include as much detail as possible, including:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or code snippets if relevant

Pull Request Process

  • Ensure your branch is up to date with main before opening a PR.
  • Describe your changes and reference any related issues.
  • Be responsive to feedback and requested changes.

Code of Conduct

Please be respectful and considerate in all interactions. We follow the Contributor Covenant Code of Conduct.

Thank you for helping make Replicheck better