XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
747 stars 186 forks source link

Docs cleanup for contribution #561

Closed Aaron-Robertson closed 3 years ago

Aaron-Robertson commented 3 years ago

Context:

Cleanup documentation for ease of contribution based on this slack conversation.

Description of the Change:

Benefits:

Makes it easier for new contributors.

Possible Drawbacks:

N/A

Related GitHub Issues:

N/A

codecov[bot] commented 3 years ago

Codecov Report

Merging #561 (0acc779) into master (de44467) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #561   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          76       76           
  Lines        8325     8325           
=======================================
  Hits         8189     8189           
  Misses        136      136           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update de44467...0acc779. Read the comment docs.

Aaron-Robertson commented 3 years ago

Alright @co9olguy @josh146, this one is ready for a bit of feedback, and I have a couple questions/thoughts.

First, for pytest-randomly and pytest-mock I included links to each of their githubs, since pypi lists it as the homepage for both. Preference for github or pypi links?

Next up, could the changelog be more visible?

I struggled to find it outside repo, and thought this line in the readme

See our contributions page for more details, and then check out some of the Strawberry Fields challenges for some inspiration.

could include a link to it as

See our contributions page and changelog for more details, and then check out some of the Strawberry Fields challenges for some inspiration.

Another couple options would be to add it to the website documentation under the contribution and/or development guide PR page(s).

Happy to broaden this cleanup (outside contribution docs) on request!

Aaron-Robertson commented 3 years ago

Thanks for the review @josh146! I added the changelog to the readme, and thought of one last question. Any desire to run black locally or just fix on GitHub check?

Could make a small development guide section to install black (or even a dev_requirements.txt and include pytest) and a make format in the scripts.

josh146 commented 3 years ago

Perfect, thanks @Aaron-Robertson!

Could make a small development guide section to install black (or even a dev_requirements.txt and include pytest) and a make format in the scripts.

If you were interesting in tackling this one as well, that would be great :) I'll merge this in now, and best to make a new PR (especially if it is for adding new content).