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

[enhancement] add an option to choose whether to use <scope> #11

Closed
BobAnkh opened this issue Aug 24, 2020 · 8 comments · Fixed by #75
Closed

[enhancement] add an option to choose whether to use <scope> #11

BobAnkh opened this issue Aug 24, 2020 · 8 comments · Fixed by #75
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed high-priority
Milestone

Comments

@BobAnkh
Copy link
Owner

BobAnkh commented Aug 24, 2020

Is your feature request related to a problem? Please describe

The changelog generater is designed for commits that follows angularjs's convention. The <header> should be like this: <type>(<scope>): <subject>. However, <scope> is optional in many projects, so I think it is better for users to choose if generater detects <scope>

Description of the new feature/enhancement

An new option to choose if detect <scope> in commit message <header>. It is set to true be default, which means to detect it.

Proposed technical implementation details (optional)

If this new option is set to false, then the program will match <type>: or <type>(<scope>): but ignore <scoope>.

Additional context

@BobAnkh BobAnkh added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Aug 24, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label enhancement to this issue, with a confidence of 0.98. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@BobAnkh
Copy link
Owner Author

BobAnkh commented Nov 17, 2020

I think we should list commits without <scope> in a part called others when this new option is set to true, as <scope> is often an optional part to developers.

@BobAnkh BobAnkh added this to the v1.0.3 milestone Jan 16, 2021
@gitmagic-app
Copy link

gitmagic-app bot commented Jan 16, 2021

Everything looks good 👍

@sruehl
Copy link
Contributor

sruehl commented Nov 16, 2021

this one defines it as optional https://www.conventionalcommits.org/en/v1.0.0/

@sruehl
Copy link
Contributor

sruehl commented Nov 16, 2021

related bug #73

@sruehl
Copy link
Contributor

sruehl commented Nov 16, 2021

so reading through https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines it is stated that The header is mandatory and the scope of the header is optional. So even in the original angular spec it's defined as optional. So I would suggest closing this(#11) issue in favor of #73 which fixes this "bug" with #75

@BobAnkh
Copy link
Owner Author

BobAnkh commented Nov 16, 2021

@sruehl

When I first created this repo, I suppose myself to commit all with a scope. But I think it is also very important to pick up commits without scope, so I open this issue.

You propose a good suggestion. I will take into account of this when I am free this week. Thank you very much!

@github-actions
Copy link
Contributor

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed high-priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants