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

[Suggestions] Improve changelog and version increments #3

Open
qvistgaard opened this issue Nov 12, 2020 · 1 comment
Open

[Suggestions] Improve changelog and version increments #3

qvistgaard opened this issue Nov 12, 2020 · 1 comment

Comments

@qvistgaard
Copy link

Hi, I just stumbled upon you project at it looks pretty promising. I would like to use for a project i'm working on. However I think that there are some small changes that I would like to see in your project. I would love to submit a pull request, but before I do, I want to ask if you like me to do so.

  • Markdown changelog only includes feat and fix, I think it should include everyting
  • Each commit should trigger at least a minor bump. it could be a commandline flag

What do you think?

@PSanetra
Copy link
Owner

PSanetra commented Dec 8, 2020

Hi @qvistgaard,

sorry for answering this late. I missed this issue somehow :-/

Markdown changelog only includes feat and fix, I think it should include everyting

Yes I also thought about introducing a command line option to toggle this behavior. I guess it would be nice to configure which commit types should be included in such a changelog. I think users would be also interested in changes of the types perf or docs, while the types refactor or ci are not really interesting for them.

Each commit should trigger at least a minor bump. it could be a commandline flag

I think the default should stay to bump only on the commit types feat, fix and any commits with breaking changes as I would like to stay compliant to the conventional commits spec. I would be ok with introducing one or multiple command line options here. Maybe one to generally bump the patch version on any commits and another one to whitelist commit types which should trigger a patch version bump. The minor version should keep to be only incremented on feature changes.

@PSanetra PSanetra changed the title Small issues and suggestions [Suggestions] Improve changelog and version increments Dec 8, 2020
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

2 participants