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

ci: define commit scope values #88

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

akihikokuroda
Copy link
Contributor

@akihikokuroda akihikokuroda commented Oct 14, 2024

Which issue(s) does this pull-request address?

Closes: #49

Description

Based on the discussion in #49. The current list of scopes are in #49 (comment)

Checklist

  • I have read the contributor guide
  • Linting passes: yarn lint or yarn lint:fix
  • Formatting is applied: yarn format or yarn format:fix
  • Unit tests pass: yarn test:unit
  • E2E tests pass: yarn test:e2e
  • Tests are included
  • Documentation is changed or added
  • Commit messages and PR title follow conventional commits

@@ -22,6 +22,24 @@
2,
"always",
"Signed-off-by"
],
"scope-enum": [
2,
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be a warning instead of an error? I mean it says "optional" in the above CONTRIBUTING.md explainer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the scope-enum section in https://commitlint.js.org/reference/rules.html has a note

This rule always passes if no scopes are provided in the message or the value > is an empty array.

It seems that the scope is always optional.

Copy link
Contributor

Choose a reason for hiding this comment

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

In the scope-enum section in https://commitlint.js.org/reference/rules.html has a note

This rule always passes if no scopes are provided in the message or the value > is an empty array.

It seems that the scope is always optional.

Sounds good to me. I tried to figure out always|never|optional but missed the scope-enum detail (and there is no optional).

Signed-off-by: Akihiko Kuroda <[email protected]>
@akihikokuroda
Copy link
Contributor Author

Hi! This is a friendly remainder. Could this be reviewed? Thanks!

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.

Define commitlint scopes
2 participants