Skip to content

Commit cc20343

Browse files
authored
Repo checklist items (#70)
Adding: - contributing guide - readme updates - support information - issue templates - component governance pipeline definition
1 parent c9fc51c commit cc20343

File tree

7 files changed

+160
-23
lines changed

7 files changed

+160
-23
lines changed

.ado/build.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: qsharp
2+
3+
trigger:
4+
- main
5+
6+
pr:
7+
- main
8+
9+
schedules:
10+
- cron: "0 9 * * Sat"
11+
displayName: 'Build for Component Governance'
12+
branches:
13+
include:
14+
- main
15+
always: true
16+
17+
jobs:
18+
- job: "qsharp"
19+
pool:
20+
vmImage: 'ubuntu-latest'
21+
steps:
22+
- task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0
23+
displayName: 'Component detection'

.github/ISSUE_TEMPLATE/bug_report.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, needs triage
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
11+
Describe what the unexpected behavior or issue is.
12+
Please file a single issue per bug instead of enumerating multiple items.
13+
14+
**To Reproduce**
15+
16+
Steps to reproduce the behavior:
17+
1. Open or go to '...'
18+
2. Type or click on '....'
19+
3. See error
20+
21+
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
22+
23+
**Expected behavior**
24+
25+
Describe what you expect to happen, versus what actually happened.
26+
27+
**Screenshots**
28+
29+
If applicable, add screenshots to help explain your problem.
30+
31+
**System information**
32+
33+
- Version of the package or extension for which the problem occurs
34+
- Your operating system
35+
- For issues with extensions, the version of the IDE for which the problem occurs
36+
37+
**Additional context**
38+
39+
Add any other context about the problem here.
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement, needs triage
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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.

LICENSE LICENSE.txt

File renamed without changes.

README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
# Project
1+
# Q# language and tooling:
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
> Under development
54
6-
As the maintainer of this project, please make a few updates:
5+
This repository contains Q# tooling, specifically:
76

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
7+
- **[compiler](./compiler/qsc/)**: command line compiler
8+
- **[library](./library/)**: standard library
9+
- **[npm](./npm/)**: Q# npm module
10+
- **[playground](./playground/)**: simple website for interacting with Q#
11+
12+
## Feedback
13+
14+
If you have feedback about the content in this repository, please let us know by filing a [new issue](https://github.com/microsoft/qsharp/issues/new/choose)!
15+
16+
## Reporting Security Issues
17+
18+
Security issues and bugs should be reported privately following our [security issue documentation](./SECURITY.md#reporting-security-issues).
1219

1320
## Contributing
1421

@@ -24,7 +31,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
2431
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
2532
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
2633

27-
## Trademarks
34+
For more details, please see [CONTRIBUTING.md](./CONTRIBUTING.md).
35+
36+
## Legal and Licensing
37+
38+
### Trademarks
2839

2940
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
3041
trademarks or logos is subject to and must follow

SUPPORT.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
7-
- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
8-
9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
10-
111
# Support
122

133
## How to file issues and get help
@@ -16,10 +6,6 @@ This project uses GitHub Issues to track bugs and feature requests. Please searc
166
issues before filing new issues to avoid duplicates. For new issues, file your bug or
177
feature request as a new Issue.
188

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
22-
239
## Microsoft Support Policy
2410

2511
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.

0 commit comments

Comments
 (0)