Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 4.1 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone, regardless of your level of experience. By contributing, you not only help improve the project but also become part of a vibrant community.

To ensure a smooth and collaborative experience for everyone, please take a moment to review the guidelines outlined below before making your contribution.

How Can You Contribute?

You can contribute to our project in various ways, including but not limited to:

  1. Report bugs, issues, or suggest enhancements by opening an issue.
  2. Fix bugs, address issues, or implement new features by submitting pull requests (PRs).
  3. Provide feedback on existing features, documentation, or user experience.
  4. Help improve documentation by fixing typos, clarifying explanations, or adding examples.
  5. Add new sub-tabs to any of the main-tabs (i.e., overview, documentation, references).
  6. Add new pages to any of the sub-tabs.
  7. You can either correct the existing content or add new content to the existing pages or create entirely new content (but make sure to follow the content flow as given in the project structure).
  8. You can add new references to the references tab.
  9. You can add new plugins to the documentation, but make sure to follow the mkdocs plugins for reference.
  10. You can also change the setup of the documentation, but make sure to follow the mkdocs setup for reference.

Getting Started

If you're new to contributing to open-source projects or our project specifically, here are some steps to get started:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes (git checkout -b your-branch-name).
  4. Make your desired changes and ensure they adhere to our coding standards and guidelines.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your changes to your forked repository (git push origin your-branch-name).
  7. Open a pull request (PR) against the main repository's main branch.

Code Style and Standards

To maintain consistency and readability across the codebase, we follow certain coding standards and style guidelines. Here are some general principles:

  • Use 3-4 level depth of headings in the markdown files.
  • Make sure to add captions to images, and tables.
  • If image is outsourced, then make sure to add the source of the image either in the image caption or in the reference tab.
  • To write equation in the sentence use 'MathJax' and to write equation in a separate line use 'KaTeX'.
  • Any new equation written using 'KaTex' should have a equation number.
  • If writing code for demonstration, then make sure to use ONE single library (either use qiskit or pennylane or cirq) to demonstrate the topic.
  • Use the mkdocs markdown syntax for writing the documentation.

Code Review Process

All contributions go through a code review process to ensure the quality and integrity of the codebase. Here's what to expect:

  1. Once you've submitted a pull request (PR), our team will review your changes.
  2. We may provide feedback, suggestions, or requests for changes.
  3. You can address the feedback by making additional commits to your branch.
  4. Once approved, your PR will be merged into the main repository.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on our GitHub repository. When opening an issue, please provide as much detail as possible, including steps to reproduce the problem and your environment.

License

By contributing to our project, you agree that your contributions will be licensed under the project's license.

Contact Us

If you have any questions, concerns, or need further assistance, feel free to reach out to us via email or open a discussion on the GitHub repository.

We appreciate your interest in contributing to our project and look forward to your contributions!