Update README with Github discussion link #2419
Conversation
|
Thanks! Should we maybe add a bit more specificity, e.g. "for code or repo specific questions, submit a Discussion or for time sensitive questions, chat with us on Discord" |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2419 +/- ##
=======================================
Coverage 98.32% 98.32%
=======================================
Files 87 87
Lines 4048 4048
=======================================
Hits 3980 3980
Misses 68 68 ☔ View full report in Codecov by Sentry. |
|
Thanks for the suggestion. I wanted to also point out that if a question is more complex and requires back and forth that the Discussions is preferred. |
README.md
Outdated
| @@ -19,7 +19,7 @@ Error mitigation seeks to reduce these effects at the software level by | |||
| compiling quantum programs in clever ways. | |||
|
|
|||
| Want to know more? Check out our | |||
| [documentation](https://mitiq.readthedocs.io/en/stable/guide/guide.html), chat with us on [Discord](http://discord.unitary.fund), and join our weekly community call ([public agenda](https://docs.google.com/document/d/1lZfct4AOCS7fdyWkudcGyER0n0nsCxSFKSicUEeJgtA/)). | |||
| [documentation](https://mitiq.readthedocs.io/en/stable/guide/guide.html). For code, repo, or theory questions, especially those requiring more detailed responses, submit a [Discussion](https://github.com/unitaryfund/mitiq/discussions). For time sensitive questions, chat with us on [Discord](http://discord.unitary.fund). Also, join our weekly community call ([public agenda](https://docs.google.com/document/d/1lZfct4AOCS7fdyWkudcGyER0n0nsCxSFKSicUEeJgtA/)). | |||
There was a problem hiding this comment.
Thanks for adding more context. Just to make sure it's readable, could we split into bullet points perhaps?
- docs
- discussions
- time sensitive or casual
There was a problem hiding this comment.
I split it into bullet points and also added on Discord for the weekly community call.
README.md
Outdated
| [documentation](https://mitiq.readthedocs.io/en/stable/guide/guide.html). | ||
| - For code, repo, or theory questions, especially those requiring more detailed responses, submit a [Discussion](https://github.com/unitaryfund/mitiq/discussions). | ||
| - For casual or time sensitive questions, chat with us on [Discord](http://discord.unitary.fund). | ||
| - Join our weekly community call ([public agenda](https://docs.google.com/document/d/1lZfct4AOCS7fdyWkudcGyER0n0nsCxSFKSicUEeJgtA/)) on [Discord](http://discord.unitary.fund). |
There was a problem hiding this comment.
Fantastic. I would just swap the order of the agenda and link to discord:
community call on Discord (public agenda).
There was a problem hiding this comment.
otherwise lgtm, you are good to merge!
* Update README with Github discussion link * Changed the wording to give more context * Changed formatting to make it more readable * Finalized wording
Description
fixes #2418
This adds the Github discussion link to the main README page.
License