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

Respecting the optional scope in Conventional Commits #179

Open
kecrily opened this issue Aug 3, 2022 · 3 comments
Open

Respecting the optional scope in Conventional Commits #179

kecrily opened this issue Aug 3, 2022 · 3 comments
Labels
Projects

Comments

@kecrily
Copy link
Member

kecrily commented Aug 3, 2022

The Pull Request section of the ESLint documentation explicitly mentions that

All ESLint projects follow Conventional Commits for our commit messages1.

The convention for Conventional Commits is

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

However, ESLint Bot doesn't recognize the scope part of the commit message, so contributors who are already used to Conventional Commits have to modify the commit message to remove the scope part and recommit.

This caused some trouble. ESLint uses, but not exclusively, Conventional Commits

Footnotes

  1. Pull Requests - ESLint - Pluggable JavaScript Linter

@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Aug 3, 2022
@nzakas
Copy link
Member

nzakas commented Aug 4, 2022

Yeah, unfortunately it needs to be this way for now. It’s not just that the bot needs to change, it’s the release process in general that doesn’t understand conventional commits scopes. We are looking at some alternatives but for now we can’t support scopes in commit messages.

@nzakas nzakas moved this from Needs Triage to Blocked in Triage Aug 4, 2022
@jedwards1211
Copy link

jedwards1211 commented Oct 17, 2022

Why not just use commitlint?

Commitlint would also state exactly what's wrong with the commit message. The current process is kind of opaque and was a head scratcher for me since I write conventional commit messages every day, so my commit message adhered to the spec but I had no idea what eslint-github-bot didn't like about it.

@nzakas
Copy link
Member

nzakas commented Oct 17, 2022

@jedwards1211 please see the preceding comment. It’s our whole tooling system that would need to change, not just the bot commit check.

nzakas added a commit to eslint/eslint that referenced this issue Oct 25, 2022
* docs: note commit messages don't support scope

eslint/eslint-github-bot#179 (comment)

* Update docs/src/developer-guide/contributing/pull-requests.md

Co-authored-by: Nicholas C. Zakas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Blocked
Triage
Blocked
Development

No branches or pull requests

3 participants