Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.27 KB
Raw

Contributing to Quantum Compression System

We love your input! We want to make contributing to the Quantum Compression System as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Pull Request Process

  1. Update the README.md with details of changes to the interface, if applicable.
  2. Update the requirements.txt if you've added new dependencies.
  3. The PR will be merged once you have the sign-off of at least one other developer.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's [issue tracker]

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Code Style Guidelines

  • Use consistent naming conventions
  • Write clear, readable code
  • Comment complex algorithms
  • Follow PEP 8 guidelines for Python code

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Include both positive and negative test cases

Documentation

  • Update relevant documentation for any changes
  • Include docstrings for new functions/classes
  • Keep API documentation up to date

License

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