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 a changelog.rst file #251

Open
cristiansteib opened this issue Oct 25, 2021 · 2 comments
Open

Add a changelog.rst file #251

cristiansteib opened this issue Oct 25, 2021 · 2 comments

Comments

@cristiansteib
Copy link

I think it could be good for the whole community to know what changes are involved in every release. Could you consider adding a changelog.rst file at the top of the repository.

This https://changelog.md/ is a good changelog standard. If you consider this, also consider that every pull request must include the changes in the changelog.rst.

@alanjds
Copy link
Owner

alanjds commented Oct 25, 2021

Yeah, I considered this more than once.

Researched more than one tool, even automated ones, and found that I like the way https://pypi.org/project/towncrier/ works. Yet had not enforced something like this.

@gdvalderrama
Copy link

This is actually requested here #113
It'd be nice to have at least a basic changelog to start if figuring out of to automate it is too time consuming

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

3 participants