Skip to content

add a changelog #232

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

Merged
merged 3 commits into from
Mar 7, 2021
Merged

add a changelog #232

merged 3 commits into from
Mar 7, 2021

Conversation

jbweston
Copy link
Contributor

@jbweston jbweston commented Nov 28, 2019

We move fast and break things. For everyone's sanity it would be good to keep a changelog where we document what stuff we added, fixed and changed.

TODO

  • Add changelog entries for the previous releases (using the release notes)
  • Add changelog entry for the unreleased changes
  • Add the sphinx versionadded directive to relevant docstrings so that we know when stuff was added.

@basnijholt
Copy link
Member

The changes are documented to some degree here.

@jbweston
Copy link
Contributor Author

The changes are documented to some degree here.

That's where we'll get the information to help with bullet point (1), but it is useful to keep this information in the repository because then we can do things like add it to the documentation

@basnijholt
Copy link
Member

I've added the entries from https://github.com/python-adaptive/adaptive/releases.

I think we can already merge this and open issues for the other two points @jbweston brought up.

@basnijholt basnijholt force-pushed the feature/changelog branch 2 times, most recently from 0afa38a to f6309cf Compare December 13, 2019 21:28
@jbweston
Copy link
Contributor Author

@basnijholt do you mind if I fixup the changelog to separate the issues solved into bugfixes and features, in order to conform to the KeepAChangelog format?

@jbweston
Copy link
Contributor Author

👍 on making the other 2 things separate issues

docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator -u python-adaptive -p adaptive -t TOKEN_HERE
@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (master@c084704). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #232   +/-   ##
=========================================
  Coverage          ?   80.63%           
=========================================
  Files             ?       34           
  Lines             ?     4591           
  Branches          ?      828           
=========================================
  Hits              ?     3702           
  Misses            ?      765           
  Partials          ?      124           

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 c084704...cebbd1c. Read the comment docs.

@basnijholt basnijholt changed the title WIP: add a changelog add a changelog Mar 7, 2021
@basnijholt
Copy link
Member

I am going to go ahead and merge this.

@jbweston, the things you wanted to fix, we can always do later. Having any changelog is more valuable than not having it.

@basnijholt basnijholt merged commit 3142fa8 into master Mar 7, 2021
@basnijholt basnijholt deleted the feature/changelog branch March 7, 2021 17:44
@basnijholt
Copy link
Member

See #306.

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.

3 participants