Skip to content

Commit

Permalink
[Docs] Add support page for issues, requests, and questions (#3835)
Browse files Browse the repository at this point in the history
To increase user feedback and make it clear how to report issues on the website.

cc @balopat @lamberta @karlunho 

Note: Cirq is the only repo with issue templates.
  • Loading branch information
rmlarose committed Mar 2, 2021
1 parent 3435a2c commit 8d17c73
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/_book.yaml
Expand Up @@ -67,6 +67,8 @@ upper_tabs:
path: /cirq/custom_gates
- title: "Operators and observables"
path: /cirq/operators_and_observables
- title: "Issues / requests / questions"
path: /cirq/support

#### Contributor Guide ####
- heading: "Contributor guide"
Expand Down
29 changes: 29 additions & 0 deletions docs/support.md
@@ -0,0 +1,29 @@
# Report an issue or request a feature

| Project | Issue tracker |
|---------|--------------------|
| Cirq | https://github.com/quantumlib/Cirq/issues |
| OpenFermion | https://github.com/quantumlib/OpenFermion/issues |
| ReCirq | https://github.com/quantumlib/ReCirq/issues |
| qsim | https://github.com/quantumlib/qsim/issues |
| Tensorflow Quantum |https://github.com/tensorflow/quantum/issues |

To report an issue or request a feature in our open-source projects,
first check if there is already an open issue for your bug report /
feature request at the links above. If not, file an issue by following
the provided template and/or contributing guidelines. Thanks for helping
improve open-source quantum software!

# Questions

If you're not sure whether a certain behavior is buggy, or if you have other questions,
please ask us in the [Cirq Gitter channel](https://gitter.im/cirqdev).

# Weekly developer meetings

You may also be interested to join the weekly
[Cirq sync](https://groups.google.com/g/cirq-dev) with Cirq developers and
contributors. There are also weekly syncs for
[OpenFermion](https://groups.google.com/g/openfermion-dev),
[qsim](https://groups.google.com/g/qsim-qsimh-dev), and
[TensorFlow Quantum](https://groups.google.com/g/openfermion-dev).

0 comments on commit 8d17c73

Please sign in to comment.