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

Add change log markdown file #328

Merged
merged 6 commits into from
Aug 25, 2020
Merged

Add change log markdown file #328

merged 6 commits into from
Aug 25, 2020

Conversation

nathanshammah
Copy link
Member

@nathanshammah nathanshammah commented Aug 25, 2020

Description

Add CHANGELOG.md in the root directory, including it in the top bar menu of the documentation. Ticks a box in #268.

Checklist

Please make sure you have finished the following tasks before requesting a review of the pull request (PR). For more information, please refer to the Contributor's Guide:

  • Contributions to mitiq should follow the pep8 style. You can enforce it easily with black style and with flake8 conventions.
  • Please add tests to cover your changes, if applicable, and make sure that all new and existing tests pass locally.
  • If the behavior of the code has changed or new feature has been added, please also update the documentation.
  • Functions and classes have useful Google-style docstrings and type hints in the signature of the objects.
  • The changelog is updated, including author and PR number (@username, gh-xxx).

@codecov
Copy link

codecov bot commented Aug 25, 2020

Codecov Report

Merging #328 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #328   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          17       17           
  Lines         827      827           
=======================================
  Hits          759      759           
  Misses         68       68           

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 372d9f8...c175e72. Read the comment docs.

@nathanshammah nathanshammah requested review from karalekas, willzeng, andreamari and rmlarose and removed request for karalekas August 25, 2020 15:46
@willzeng willzeng merged commit 21b0d6f into master Aug 25, 2020
@willzeng willzeng deleted the changelog branch August 25, 2020 15:52
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.

2 participants