Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 2.37 KB

Contributing to Quantum Computing Research

Thank you for considering contributing to the Quantum Computing Research project! We welcome contributions from the community and are grateful for your support.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue on our GitHub repository. Describe your idea in detail and explain why it would be beneficial to the project.

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.

  2. Clone the Forked Repository: Clone the forked repository to your local machine.

    git clone https://github.com/yourusername/quantum-computing-research.git

  3. Create a New Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code follows the project's coding standards and includes appropriate tests.

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git commit -m "Add feature: your feature description"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Open a Pull Request: Go to the original repository and open a pull request. Provide a clear and detailed description of your changes and why they should be merged.

Coding Standards

  • Follow the PEP 8 style guide for Python code.
  • Write clear and concise comments and docstrings.
  • Ensure that your code is well-documented and easy to understand.

Running Tests

Before submitting a pull request, ensure that all tests pass. You can run the tests using the following command:

pytest

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Getting Help

If you need help or have any questions, feel free to open an issue on our GitHub repository or contact the project maintainers.

Thank you for your contributions!