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 more changelog sections #1244

Closed
ST-DDT opened this issue Aug 8, 2022 · 2 comments · Fixed by #1304
Closed

Add more changelog sections #1244

ST-DDT opened this issue Aug 8, 2022 · 2 comments · Fixed by #1304
Assignees
Labels
c: bug Something isn't working c: infra Changes to our infrastructure or project setup p: 2-high Fix main branch s: accepted Accepted feature / Confirmed bug

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Aug 8, 2022

Clear and concise description of the problem

The changelog.md does not contain hints regarding locale updates and refactors.
Especially the later are quite important as these could be considered (future) breaking changes.

Suggested solution

Add more sections to the changelog.

Alternative

Remove all of the commit prefixes except:

  • feat
  • fix
  • chore
  • docs
  • test
  • infra

Additional context

  • The changelog.md should be updated retrospectively.
@ST-DDT ST-DDT added c: bug Something isn't working p: 2-high Fix main branch s: needs decision Needs team/maintainer decision c: infra Changes to our infrastructure or project setup labels Aug 8, 2022
@ST-DDT ST-DDT added this to the v7 - Current Major milestone Aug 8, 2022
@Shinigami92
Copy link
Member

My assumption currently is that we moved away a bit from what standard-version expect

"release": "standard-version",

So this package might only know feat and fix and ignores things like chore and custom created types

It ignores things like chore because these are not relevant for users to read
It doesn't know what a custom type like locale is and therefore cannot categories it below the headers Features and Bug Fixes (I mean how could it 🤷)

So our assumption of "messing around" with scopes and types were a bit misleading and standardized tools could not handle it
I would suggest to move back to the standard / how it should be used, instead of crafting out custom types and scoped

@xDivisionByZerox xDivisionByZerox self-assigned this Aug 26, 2022
@Shinigami92 Shinigami92 changed the title Changelog does not contain locale updates and refactors Add more changelog sections Dec 15, 2022
@Shinigami92 Shinigami92 added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Dec 15, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Dec 15, 2022

Team decision

  • We want to have a section for locale updates and refactors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: bug Something isn't working c: infra Changes to our infrastructure or project setup p: 2-high Fix main branch s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants