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

closes #108 Created CHANGELOG.md with the last five changes #330

Closed
wants to merge 1 commit into from
Closed

Conversation

Jiwoo22
Copy link

@Jiwoo22 Jiwoo22 commented Oct 10, 2020

Created a changelog using the format from keep a changelog

  • Note each version tag in the changelog may contain (Added, Changes, Removed) sub sections every time changes are made to the repo.

@Jiwoo22 Jiwoo22 requested a review from a team as a code owner October 10, 2020 01:36
@Jiwoo22
Copy link
Author

Jiwoo22 commented Oct 10, 2020

This is my first PR in my life

Copy link
Contributor

@mnicpt mnicpt left a comment

Choose a reason for hiding this comment

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

Congrats, @jchoi136, on your first PR!🚀

@apuntovanini
Copy link

Well done @jchoi136!!

If I may, the PR fixes an issue but we'll have the same problem in few commits/releases unless this becomes an automated process. @mnicpt what do you think about https://github.com/atlassian/changesets or https://github.com/conventional-changelog/standard-version?

@songz
Copy link

songz commented Oct 18, 2020

ping @bluepnume any thoughts on @apuntovanini 's comments? I feel like commit automation may not be as human readable as user written updates, especially when sometimes commits usually parts of an overall feature and only the overall feature is important enough to be written.

@bluepnume
Copy link
Collaborator

I worry without some kind of automation, we'll end up falling behind with manually keeping a change-log up to date. Plus, we have "squash and merge" set as default on all of these repos; so any PRs should ideally cover an entire, atomic change that should fit neatly into a change-log. We do need to be good at enforcing good commit/pr messages, though.

@apuntovanini
Copy link

Actually @changesets/cli (for instance) is automated in the sense that enforces a standard for publishing changesets with proper commits, and automatically builds changelogs. I find it very useful, but, yes, it's strongly related to how contributing / merging and releasing is structured. You can see some examples in https://atlassian.design/components/banner/code (click on changelog on the right)
Thanks for the discussion!

This pull request was closed.
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.

5 participants