Checklist for public release of mitiq #268

nathanshammah · 2020-07-28T18:28:45Z

willzeng · 2020-07-28T19:08:35Z

Some comments:

asking folks to check code with black

What does this mean @nathanshammah ?

consider using docker for CI even beyond PyQuil (In a python-only environment this may be an overkill, but certainly it makes everything robust)
consider adding templates for PRs or issues: It would certainly help new contributors, may be cumbersome for UF team.

These IMO are not needed for launch. They can be added later.

have guides for contributors and maintainers and possibly autoreleases to pypi, test pypi.

We have contributor guides already no? @karalekas How much work is it to set up the autoreleases?

nathanshammah · 2020-07-28T19:12:50Z

@willzeng edited that item to make it more clear:
check code formatting with black or pycodestyle.

karalekas · 2020-07-29T20:52:59Z

@willzeng

setting up the autoreleases shouldn't take more than a couple of hours -- i'm happy to take that on
as for contributor guides, it's probably worth taking a day and combing through the various markdown files in the repo just to make sure they're updated to reflect the latest repo contents, install instructions, etc.
re: black / code style -- if we want to use this & enforce in the CI, id recommend doing so before external contributors come in. would only take an hour or so

karalekas · 2020-07-29T20:55:54Z

another potential checklist item: type checking with mypy. this is another code quality thing that can be enforced with CI, and is of course easier to implement the sooner you do it. my guess would be about half a day, only because I'd need to understand the QPROGRAM issue (#253)

karalekas · 2020-07-29T21:03:04Z

yet another potential checklist item: enforcing code coverage. this can be done using coveralls. we're currently at ~85%, and id bet we could get it over 90% in an hour

Name                                                    Stmts   Miss  Cover
---------------------------------------------------------------------------
mitiq/__init__.py                                           5      0   100%
mitiq/_about.py                                            24     11    54%
mitiq/_typing.py                                           10      2    80%
mitiq/_version.py                                           4      0   100%
mitiq/benchmarks/__init__.py                                0      0   100%
mitiq/benchmarks/maxcut.py                                 45      1    98%
mitiq/benchmarks/random_circuits.py                        44      2    95%
mitiq/benchmarks/randomized_benchmarking.py                20      1    95%
mitiq/benchmarks/tests/test_maxcut.py                      17      0   100%
mitiq/benchmarks/tests/test_random_circuit.py              31      0   100%
mitiq/benchmarks/tests/test_randomized_benchmaking.py      42      0   100%
mitiq/benchmarks/utils.py                                   8      0   100%
mitiq/factories.py                                        224     27    88%
mitiq/folding.py                                          236      8    97%
mitiq/mitiq_pyquil/__init__.py                              0      0   100%
mitiq/mitiq_pyquil/conversions.py                          12     12     0%
mitiq/mitiq_pyquil/pyquil_utils.py                         65     65     0%
mitiq/mitiq_pyquil/quil.py                                 63     63     0%
mitiq/mitiq_pyquil/tests/__init__.py                        0      0   100%
mitiq/mitiq_pyquil/tests/test_conversions.py                0      0   100%
mitiq/mitiq_pyquil/tests/test_quil.py                      23     23     0%
mitiq/mitiq_pyquil/tests/test_zne.py                       38     38     0%
mitiq/mitiq_qiskit/__init__.py                              2      0   100%
mitiq/mitiq_qiskit/conversions.py                          12      0   100%
mitiq/mitiq_qiskit/qiskit_utils.py                         32     19    41%
mitiq/tests/test_factories.py                             174      0   100%
mitiq/tests/test_folding.py                               552      0   100%
mitiq/tests/test_utils.py                                 110      0   100%
mitiq/tests/test_zne.py                                    39      3    92%
mitiq/utils.py                                             19      1    95%
mitiq/zne.py                                               26      0   100%
---------------------------------------------------------------------------
TOTAL                                                    1877    276    85%

karalekas · 2020-07-29T21:05:51Z

these two I think are definitely worth doing, even if you choose to pass for now on mypy / coverage stuff:

Move the changes.rst to the top-level directory and make it a markdown file. Having a markdown changelog and requiring contributors to add to it when opening a PR is a really great way to let release notes write themselves.
Clean up the README -- add some badges, add some color, add a code snippet w/ syntax highlighting, etc. Right now the main attraction is the source tree, which is not very exciting

nathanshammah · 2020-07-29T21:08:30Z

yet another potential checklist item: enforcing code coverage. this can be done using coveralls. we're currently at ~85%, and id bet we could get it over 90% in an hour

Name                                                    Stmts   Miss  Cover
---------------------------------------------------------------------------
mitiq/__init__.py                                           5      0   100%
mitiq/_about.py                                            24     11    54%
mitiq/_typing.py                                           10      2    80%
mitiq/_version.py                                           4      0   100%
mitiq/benchmarks/__init__.py                                0      0   100%
mitiq/benchmarks/maxcut.py                                 45      1    98%
mitiq/benchmarks/random_circuits.py                        44      2    95%
mitiq/benchmarks/randomized_benchmarking.py                20      1    95%
mitiq/benchmarks/tests/test_maxcut.py                      17      0   100%
mitiq/benchmarks/tests/test_random_circuit.py              31      0   100%
mitiq/benchmarks/tests/test_randomized_benchmaking.py      42      0   100%
mitiq/benchmarks/utils.py                                   8      0   100%
mitiq/factories.py                                        224     27    88%
mitiq/folding.py                                          236      8    97%
mitiq/mitiq_pyquil/__init__.py                              0      0   100%
mitiq/mitiq_pyquil/conversions.py                          12     12     0%
mitiq/mitiq_pyquil/pyquil_utils.py                         65     65     0%
mitiq/mitiq_pyquil/quil.py                                 63     63     0%
mitiq/mitiq_pyquil/tests/__init__.py                        0      0   100%
mitiq/mitiq_pyquil/tests/test_conversions.py                0      0   100%
mitiq/mitiq_pyquil/tests/test_quil.py                      23     23     0%
mitiq/mitiq_pyquil/tests/test_zne.py                       38     38     0%
mitiq/mitiq_qiskit/__init__.py                              2      0   100%
mitiq/mitiq_qiskit/conversions.py                          12      0   100%
mitiq/mitiq_qiskit/qiskit_utils.py                         32     19    41%
mitiq/tests/test_factories.py                             174      0   100%
mitiq/tests/test_folding.py                               552      0   100%
mitiq/tests/test_utils.py                                 110      0   100%
mitiq/tests/test_zne.py                                    39      3    92%
mitiq/utils.py                                             19      1    95%
mitiq/zne.py                                               26      0   100%
---------------------------------------------------------------------------
TOTAL                                                    1877    276    85%

@karalekas, about this: we had a discussion some time back (#122), and neither one of us seemed to know the difference between coveralls and pytest-cov. Are they just the same service, the former wrapped with APIs so that it shows up in the GH PR conversation, the latter more basic? The first one can be more helpful, the second one is less "intrusive". Personally, I am happy to go for it.

rmlarose · 2020-07-29T21:31:37Z

+1 for coverage and mypy.

willzeng · 2020-07-30T00:22:10Z

+1 for coverage and mypy

…

On Wed, Jul 29, 2020, 5:31 PM Ryan LaRose ***@***.***> wrote: +1 for coverage and mypy. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#268 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABHZDAS3UTGPSELCXLVD6HTR6CIMTANCNFSM4PKZQRLA> .

karalekas · 2020-08-02T19:09:21Z

Added CHANGELOG.md and README.md bullets to the issue description, which we can discuss tomorrow @nathanshammah

karalekas · 2020-08-03T17:10:35Z

NB: Once we open-source the repo, we should drop the review-requested/assigned restriction on triggering the build.

willzeng · 2020-08-04T19:12:30Z

This is a good point. What should we replace it with? We’ll still want to be conservative about eating up too much of our cloud compute github time.

On Mon, Aug 3, 2020 at 13:10 Peter Karalekas ***@***.***> wrote: NB: Once we open-source the repo, we should drop the review-requested/assigned restriction on triggering the build. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#268 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABHZDAXNEJP6IRQ5HJ54XC3R63VRVANCNFSM4PKZQRLA> . --

https://unitary.fund/ Creating a quantum technology ecosystem that benefits the most people.

willzeng · 2020-08-21T16:02:05Z

@karalekas These are the current usage stats:

willzeng · 2020-08-24T23:31:43Z

#316 checked a box here

willzeng · 2020-08-27T19:15:40Z

With #330 the needed parts for this issue are checked and so will close this issue

nathanshammah assigned karalekas and nathanshammah Jul 28, 2020

willzeng added this to the Alpha v4 milestone Jul 28, 2020

nathanshammah mentioned this issue Aug 3, 2020

Add template for pull requests and issues #277

Closed

karalekas mentioned this issue Aug 4, 2020

Use the Black autoformatter to enforce code style #279

Merged

This was referenced Aug 7, 2020

Add templates for PRs and issues #284

Merged

Add a coverage reporting service #299

Closed

karalekas mentioned this issue Aug 14, 2020

Add Codecov for testing code coverage in the CI #301

Merged

rmlarose modified the milestones: Alpha v4, Alpha v5 Aug 14, 2020

nathanshammah mentioned this issue Aug 25, 2020

Add change log markdown file #328

Merged

5 tasks

willzeng closed this as completed Aug 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Checklist for public release of mitiq #268

Checklist for public release of mitiq #268

nathanshammah commented Jul 28, 2020 •

edited by willzeng

Loading

willzeng commented Jul 28, 2020

nathanshammah commented Jul 28, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

nathanshammah commented Jul 29, 2020

rmlarose commented Jul 29, 2020

willzeng commented Jul 30, 2020 via email

karalekas commented Aug 2, 2020 •

edited

Loading

karalekas commented Aug 3, 2020

willzeng commented Aug 4, 2020 via email

willzeng commented Aug 21, 2020

willzeng commented Aug 24, 2020

willzeng commented Aug 27, 2020

Checklist for public release of mitiq #268

Checklist for public release of mitiq #268

Comments

nathanshammah commented Jul 28, 2020 • edited by willzeng Loading

willzeng commented Jul 28, 2020

nathanshammah commented Jul 28, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

karalekas commented Jul 29, 2020

nathanshammah commented Jul 29, 2020

rmlarose commented Jul 29, 2020

willzeng commented Jul 30, 2020 via email

karalekas commented Aug 2, 2020 • edited Loading

karalekas commented Aug 3, 2020

willzeng commented Aug 4, 2020 via email

willzeng commented Aug 21, 2020

willzeng commented Aug 24, 2020

willzeng commented Aug 27, 2020

nathanshammah commented Jul 28, 2020 •

edited by willzeng

Loading

karalekas commented Aug 2, 2020 •

edited

Loading