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

chore: set up CHANGELOG #7

Open
AngryMaciek opened this issue Sep 24, 2021 · 0 comments
Open

chore: set up CHANGELOG #7

AngryMaciek opened this issue Sep 24, 2021 · 0 comments

Comments

@AngryMaciek
Copy link

I see that you stick to major.minor.patch versioning scheme and release new versions of the package.
Thats good!

It would be additionally nice to set up a changelog in CHANGELOG.md file in the root directory, describing features in bullet points. Please take a look here.

Speaking about versioning stuff, I think you could automate the release with this package. That way based on your commits GH would create new releases and then the CI would pick that up and push to PyPI as well.
(But that is a separate issue from the changelog, if you decide to go for it feel free to separate them).

Also, take a look at this commit msg standard: https://www.conventionalcommits.org/en/v1.0.0-beta.2/

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

No branches or pull requests

1 participant