|
| 1 | +# Contributing to Q# |
| 2 | + |
| 3 | +Welcome, and thank you for your interest in contributing to Q# and the Quantum Development Kit! |
| 4 | + |
| 5 | +## Asking and Answering Questions |
| 6 | + |
| 7 | +Have a question? The `q#` tags on [Stack Overflow](https://stackoverflow.com/questions/tagged/q%23) and [Quantum Computing StackExchange](https://quantumcomputing.stackexchange.com/questions/tagged/q%23) are great places to ask questions about Q#, Quantum Development Kit and quantum computing in general. |
| 8 | +You can learn more about our work on the [Q# Development Blog](https://devblogs.microsoft.com/qsharp/) and ask questions in the comments as well. |
| 9 | +Your question will server as resource to others searching for help. |
| 10 | + |
| 11 | +## Reporting Issues |
| 12 | + |
| 13 | +Have you identified a reproducible problem in the Quantum Development Kit? |
| 14 | +Have a feature request? |
| 15 | +We want to hear about it! |
| 16 | + |
| 17 | +You can follow the [template](https://github.com/microsoft/qsharp/issues/new?assignees=&labels=bug&template=bug_report.md&title=) for reporting issues on this repository. |
| 18 | + |
| 19 | +## Contributing Code |
| 20 | + |
| 21 | +If you are interested in helping fix issues you or someone else encountered, |
| 22 | +please make sure that the corresponding issue has been filed on the repository. |
| 23 | +Check that nobody is currently working on it and that it has indeed been marked as bug. |
| 24 | +If that's the case, indicate on the issue that you are working on it, |
| 25 | +and link to the corresponding GitHub page where the fix is being developed. |
| 26 | +If someone is already working on a fix, ask if you can help or see what other things can be done. |
| 27 | +If an issue is labeled as feature, please follow the guidelines related to contributing features. |
| 28 | +Sometimes it may take a couple of days for us to label issues appropriately. |
| 29 | +If an issue has not been labeled yet, please indicate that you would like to work on it and be patient - |
| 30 | +we are a small team and are doing our best to be quick with responding to your inquiry! |
| 31 | + |
| 32 | +**Note:** |
| 33 | +Issues related to the design and evolution of the Q# language are marked with |
| 34 | +[Area-Language](https://github.com/microsoft/qsharp/issues?q=is%3Aissue+is%3Aopen+label%3AArea-Language). |
| 35 | + |
| 36 | +If you are interested in contributing a new feature, |
| 37 | +please first check if a similar functionality has already been requested. |
| 38 | +If so, consider contributing to the discussion around it rather than filing a separate issue. |
| 39 | +If no open or closed issue with such a request already exists, |
| 40 | +please file one following the [feature request template](https://github.com/microsoft/qsharp/issues/new?assignees=&labels=feature&template=feature_request.md&title=). |
| 41 | +We will respond to feature requests and follow up with a discussion around its feasibility, |
| 42 | +how one might go about implementing it, and whether that is something we would consider adding to our repo. |
| 43 | +There are several reasons why we might not be able to eventually merge even a great feature for one reason or another. |
| 44 | +Take a look at our general contribution guide for [reasons why this might be the case](https://docs.microsoft.com/azure/quantum/contributing-code#when-a-pull-request-is-rejected). |
| 45 | +Even if we are not able to incorporate something into the packages and extensions we distribute, |
| 46 | +we encourage you to pursue your passion project in your own fork, |
| 47 | +and share and discuss your thoughts and progress on the corresponding issue. |
| 48 | + |
| 49 | +If you are looking for a place to get started with contributing code, |
| 50 | +search for example for the [good-first-issue](https://github.com/microsoft/qsharp/labels/good%20first%20issue) or [help-wanted](https://github.com/microsoft/qsharp/labels/help%20wanted) labels. |
| 51 | +Also, look for issues that have already been discussed in more detail, |
| 52 | +and check if you can help someone who has already started working on it. |
| 53 | + |
| 54 | +And last but not least: |
| 55 | + |
| 56 | +# Thank You! |
| 57 | + |
| 58 | +Your contributions to open source, large or small, make great projects like this possible. |
| 59 | +Thank you for taking the time to contribute. |
0 commit comments