Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1009 Bytes

contributing.md

File metadata and controls

35 lines (26 loc) · 1009 Bytes
Raw

Contributing to Q* Algorithm

Thank you for considering contributing to the Q* Algorithm project! Here are some guidelines to help you get started:

How to Contribute

  1. Fork the Repository: Create your own fork of the repository.
  2. Create a Branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature-name
  3. Make Changes: Implement your changes or new features.
  4. Commit Your Changes: 
    git add .
git commit -m "Description of your changes"
  5. Push to Your Fork: 
    git push origin feature/your-feature-name
  6. Create a Pull Request: Submit a pull request from your branch to the main repository.

Code Standards

  • Follow PEP 8 coding standards.
  • Write clear, concise commit messages.
  • Ensure your code is well-documented.

Testing

Please write tests for any new features or bug fixes. Tests should be placed in the tests/ directory.

Thank you for your contribution!