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 changelog to docs #1066

Merged
merged 4 commits into from
Dec 29, 2022
Merged

Add changelog to docs #1066

merged 4 commits into from
Dec 29, 2022

Conversation

FabioRosado
Copy link
Contributor

We are still talking about the changelog in #1060, but we may be inclined to start by writing it manually.

This PR adds the changelog.md file under the root of our docs/ and also adds the link to the header.

We could also move the changelog outside the docs and link it to github if you think that's better 😄

@JeffersGlass
Copy link
Member

Personally I like the Changelog living in the Docs, but that's just me!

Would it be possible to link to the PR's that create the listed changes? Just something I find handy when looking at others' changelog, makes it easy to jump to the PR for more context/info.

@FabioRosado
Copy link
Contributor Author

Yeah that's a good idea I was wondering if we should 😄

Do you think we should add the contributor name as well?

In another project we do something like:

@JeffersGlass
Copy link
Member

I don't feel strongly one way or the other about adding contributor names, to be honest.

@FabioRosado
Copy link
Contributor Author

Just pushed a commit to include the PR link 😄

@marimeireles
Copy link
Member

I'm +1 for adding people's handles as an extra form of crediting them for their work, but also no strong opinions. I was copying another project changelog's I like :)
Thanks for implementing it Fabio! ✨

Copy link
Member

@marimeireles marimeireles left a comment

Choose a reason for hiding this comment

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

I think we should add a string to our CONTRIBUTING.MD just to inform people they should add a line in the CHANGELOG + maybe some light recommendations as I outlined in the issue.
Cheers and thanks!

@FabioRosado
Copy link
Contributor Author

I think we should add a string to our CONTRIBUTING.MD just to inform people they should add a line in the CHANGELOG + maybe some light recommendations as I outlined in the issue.
Cheers and thanks!

Thanks that's a great idea! Let me push a commit with that 😄

@FabioRosado FabioRosado merged commit 95783bc into pyscript:main Dec 29, 2022
@FabioRosado FabioRosado deleted the fr/changelog branch December 29, 2022 23:07
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