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

adds a changelog #54

Merged
merged 2 commits into from
Apr 7, 2023
Merged

adds a changelog #54

merged 2 commits into from
Apr 7, 2023

Conversation

johannesjh
Copy link
Owner

@johannesjh johannesjh commented Apr 5, 2023

Adds a changelog. refs #53

  • For the changelog, I simply added a new .rst file as part of req2flatpak's documentation.
  • I wrote the file by hand because this is simpler than using tools. And changelog contents should be hand-crafted in my opinion, to make them useful for users.
  • I added instructions in docs/source/development.rst so we don't forget to update the changelog when creating a release.

@johannesjh johannesjh mentioned this pull request Apr 5, 2023
5 tasks
@johannesjh johannesjh changed the title adds changelog adds a changelog Apr 5, 2023
@cbm755
Copy link
Collaborator

cbm755 commented Apr 5, 2023

I agree about hand-crafting. Here's a reference I found useful: https://keepachangelog.com

Copy link
Collaborator

@cbm755 cbm755 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@real-yfprojects real-yfprojects left a comment

Choose a reason for hiding this comment

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

LGTM. Do we want to append the changelog to the pypi page?

@johannesjh
Copy link
Owner Author

Do we want to append the changelog to the pypi page?

could be useful... I added changelog.rst to the list of readme file in pyproject.toml.

@johannesjh johannesjh added this to the v0.2 milestone Apr 6, 2023
@johannesjh johannesjh merged commit c62ee9c into main Apr 7, 2023
14 checks passed
@johannesjh johannesjh deleted the docs-changelog branch June 4, 2023 07:11
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.

None yet

3 participants