Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 3.39 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Contributions come in many forms: submitting issues, writing code, participating in discussions and community calls.

This document provides the guidelines for how to contribute to the Quantum Community Book project.

Issues

This section describes the guidelines for submitting issues

Issue Types

There are 4 types of issues:

  • Issue/Bug: You've found content that seems to be incorrect, and want to report it, or create an issue to track it.
  • Issue/Discussion: You have something on your mind, which requires input form others in a discussion, before it eventually manifests as a proposal.
  • Issue/Proposal: Used for items that propose a new idea or subject. This allows feedback from others before content is written.
  • Issue/Question: Use this issue type, if you need help or have a question.

Before You File

Before you file an issue, make sure you've checked the following:

  1. Check for existing issues
    • Before you create a new issue, please do a search in open issues to see if the issue or subject request has already been filed.
    • If you find your issue already exists, make relevant comments and add your reaction. Use a reaction:
      • 👍 up-vote
      • 👎 down-vote

Contributing to the Quantum Community Book

This section describes the guidelines for contributing content to the Quantum Community Book.

Pull Requests

All contributions come through pull requests. To submit a proposed change, we recommend this workflow:

  1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make.
  2. Fork the relevant repo and create a new branch
  3. Create your change
  4. Update relevant documentation for the change
  5. Commit and open a PR
  6. Wait for the CI process to finish and make sure all checks are green
  7. A maintainer of the project will be assigned, and you can expect a review

Use work-in-progress PRs for early feedback

A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and assign the do-not-merge label. This will let people looking at your PR know that it is not well baked yet.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.