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
Docs: Update commit message format docs (refs #14231)
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdjermanovic
reviewed
Oct 22, 2021
* `fix` - for a bug fix. | ||
* `feat` - either for a backwards-compatible enhancement or for a rule change that adds reported problems. | ||
* `fix!` - for a backwards-incompatible bug fix. | ||
* `feat!:` - for a backwards-incompatible enhancement or feature. | ||
* `docs` - changes to documentation only. | ||
* `chore` - for changes that aren't user-facing. | ||
* `build` - changes to build process only. | ||
* `refactor` - a change that doesn't affect APIs or user experience. | ||
* `test` - just changes to test files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want this list to match eslint/eslint-github-bot#158, then ci
and perf
are missing.
mdjermanovic
approved these changes
Oct 22, 2021
Merging now so that this change gets published on eslint.org, as we're switching to conventional commits after this release. We can later discuss if some tags are missing. |
1 task
This was referenced Apr 6, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
accepted
There is consensus among the team that this change meets the criteria for inclusion
archived due to age
This issue has been archived; please open a new issue for any further discussion
documentation
Relates to ESLint's documentation
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Updated the docs to explain that we are using conventional commits going forward.
Is there anything you'd like reviewers to focus on?
Are the docs clear?