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

Docs: Update commit message format docs (refs #14231) #15200

Merged
merged 1 commit into from Oct 22, 2021
Merged

Conversation

@nzakas
Copy link
Member

@nzakas nzakas commented Oct 21, 2021

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?

Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM! 👍

Loading

Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM

Loading

* `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.
Copy link
Member

@mdjermanovic mdjermanovic Oct 22, 2021

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.

Loading

@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented 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.

Loading

@mdjermanovic mdjermanovic merged commit 446b4b3 into main Oct 22, 2021
14 checks passed
Loading
@mdjermanovic mdjermanovic deleted the commits-docs branch Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants