Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added roadmap link to readme #2468

Merged
merged 3 commits into from
Aug 22, 2024
Merged

added roadmap link to readme #2468

merged 3 commits into from
Aug 22, 2024

Conversation

ecarlander
Copy link
Contributor

@ecarlander ecarlander commented Aug 13, 2024

Description

Added a direct link to the the mitiq wiki in the README. The wiki contains the 2024 roadmap, so this offers and easy way to navigate there and see what features are planned to be added.

closes #2387


License

  • I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @ecarlander, thank you for submitting a PR to Mitiq! We will respond as soon as possible, and if you have any questions in the meantime, you can ask us on the Unitary Fund Discord.

README.md Outdated
@@ -21,6 +21,7 @@ compiling quantum programs in clever ways.
Want to know more?
- Check out our
[documentation](https://mitiq.readthedocs.io/en/stable/guide/guide.html).
- To see what's in store for Mitiq this year, look at the 2024 Roadmap in the [wiki](https://github.com/unitaryfund/mitiq/wiki).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By referencing a specific year, the main README risks becoming outdated without us noticing when the year ends, giving the impression that it's old or hasn't been updated.

@natestemen natestemen changed the title added roadmap link to readme (closes #2387) added roadmap link to readme Aug 15, 2024
Copy link

codecov bot commented Aug 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (0386024) to head (22b87c2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2468   +/-   ##
=======================================
  Coverage   98.70%   98.70%           
=======================================
  Files          88       88           
  Lines        4091     4091           
=======================================
  Hits         4038     4038           
  Misses         53       53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cosenal cosenal self-requested a review August 22, 2024 17:31
Copy link
Contributor

@cosenal cosenal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for this!

@cosenal cosenal merged commit e1cd3b2 into unitaryfund:main Aug 22, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link roadmap in README
2 participants