Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (27 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.11 KB
Raw

Contributing to Q-Refine

First off, thank you for considering contributing to Q-Refine! It's people like you that make open-source such a great community to learn, inspire, and create.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/q-refine.git
  3. Install dependencies: 
    pip install -r requirements.txt

How to Contribute

We welcome contributions of all kinds:

  • Bug reports and feature requests via GitHub Issues.
  • Adding new quantum algorithms to benchmark.
  • Expanding the hardware profiler.
  • Improving documentation.

Pull Request Process

  1. Create a new branch for your feature or bugfix: git checkout -b feature/my-new-feature
  2. Make your changes and test them locally.
  3. Commit your changes with descriptive messages.
  4. Push your branch to your fork.
  5. Open a Pull Request against our main branch.

Code Style

  • Try to follow PEP 8 standards for Python code.
  • Add clear docstrings to any new modules or functions you create.