Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

94 lines (67 loc) · 3.36 KB
Raw

Contributing to TorchQuantlib

We love your input! We want to make contributing to this project 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

We Develop with Github

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

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your 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!

Any contributions you make will be under the Apache 2.0 Software License

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

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

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)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

  • 4 spaces for indentation rather than tabs
  • You can try running pylint for style unification

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft

Getting Started

For more detailed information on how to contribute to torchquantlib, please follow these steps:

  1. Ensure you have Python 3.7+ installed on your system.
  2. Install the required dependencies: 
    pip install -r requirements.txt
  3. Set up a virtual environment (recommended): 
    python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  4. Run the tests to ensure everything is set up correctly: 
    python -m unittest discover tests
  5. Make your changes and add tests for your changes.
  6. Ensure all tests pass and your code adheres to our coding style.
  7. Submit a pull request with a clear description of your changes.

Thank you for your interest in improving torchquantlib!


This CONTRIBUTING.md file provides guidelines for contributing to the torchquantlib project. It covers:

1. Different ways to contribute
2. The development process using Github Flow
3. Licensing information
4. How to report bugs
5. Coding style guidelines
6. A getting started guide for contributors
​​​​​​​​​​​​​​​​