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

Chore: Apply comment require-description and check ClassDeclaration #14949

Merged
merged 3 commits into from Aug 21, 2021

Conversation

brettz9
Copy link
Contributor

@brettz9 brettz9 commented Aug 20, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] 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
[x] Other, please explain:

What changes did you make? (Give an overview)

  • Apply comment require-description rule
  • Check ClassDeclaration (instead of constructor)

Is there anything you'd like reviewers to focus on?

In Makefile.js, I wasn't clear where target was coming from, so I wasn't sure how to document that comment.

In a few cases, I enabled the "mocha" env over whitelisting specific it and describe, as that seemed to capture the intent better, even if it may enable a few other globals.

I assumed the few jshint directives, apparently copied from a while ago, could be safely removed.

I've added the "chore" label, even though technically this does impact any users of the eslint-config-eslint config (wasn't sure whether it should be treated as "core" either, however).

@brettz9 brettz9 added the chore This change is not user-facing label Aug 20, 2021
@eslint-github-bot
Copy link

eslint-github-bot bot commented Aug 20, 2021

Hi @brettz9!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

Read more about contributing to ESLint here

@brettz9 brettz9 changed the title Chore: Apply comment require-description rule and check ClassDeclaration Chore: Apply comment require-description and check ClassDeclaration Aug 20, 2021
@eslint-github-bot
Copy link

eslint-github-bot bot commented Aug 20, 2021

Hi @brettz9!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

Read more about contributing to ESLint here

@brettz9 brettz9 force-pushed the comment-require-description branch from 5fa47ba to 2153a26 Compare Aug 20, 2021
Makefile.js Outdated Show resolved Hide resolved
bmish
bmish approved these changes Aug 20, 2021
brettz9 and others added 2 commits Aug 20, 2021
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
@brettz9 brettz9 merged commit 9a4ae3b into master Aug 21, 2021
13 checks passed
@brettz9 brettz9 deleted the comment-require-description branch Aug 21, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Feb 18, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants