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: Reference eslint-config-eslint to avoid potential for staleness #14805

Merged
merged 1 commit into from Jul 29, 2021

Conversation

@brettz9
Copy link
Contributor

@brettz9 brettz9 commented Jul 16, 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)

Avoid potential for staleness in code convention recommendations by referencing eslint-config-eslint.

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

No.

@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jul 16, 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 commit message tag must be one of the following:

    The Tag is one of the following:

    • Fix - for a bug fix.
    • Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
    • New - implements a new feature.
    • Breaking - for a backwards-incompatible enhancement or feature.
    • Docs - changes to documentation only.
    • Build - changes to build process only.
    • Upgrade - for a dependency upgrade.
    • Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).

    You can use the labels of the issue you are working on to determine the best tag.

  • There should be a space following the initial tag and colon, for example 'New: Message'.

  • 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 code-conventions-linting branch from ad18d46 to 4bcfc27 Jul 16, 2021
@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jul 16, 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 Docs(code conventions): Avoid potential for staleness in recommendations Docs: Reference eslint-config-eslint to avoid potential for staleness in code conventions Jul 16, 2021
@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jul 16, 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 code-conventions-linting branch from 4bcfc27 to 48f17d8 Jul 16, 2021
@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jul 18, 2021

Hi @brettz9!, thanks for the Pull Request

The pull request title 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 code-conventions-linting branch from 8e8442d to 463ecf8 Jul 18, 2021
@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jul 18, 2021

Hi @brettz9!, thanks for the Pull Request

The pull request title 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 code-conventions-linting branch from 463ecf8 to f1202ea Jul 18, 2021
@brettz9 brettz9 changed the title Docs: Reference eslint-config-eslint to avoid potential for staleness in code conventions Docs: Reference eslint-config-eslint to avoid potential for staleness Jul 18, 2021
nzakas
nzakas approved these changes Jul 21, 2021
Copy link
Member

@nzakas nzakas left a comment

I think this is fine. No one wants to keep updating the conventions Docs. :) Just want @btmills and @mdjermanovic to take a quick look to see if they agree.

Copy link
Member

@btmills btmills left a comment

The last substantive update was 5 years ago in #6313. I agree, this is fine. Most of it was out of date anyway since we're using ES6+ features now.

@nzakas nzakas merged commit d28f2ff into master Jul 29, 2021
14 checks passed
@nzakas nzakas deleted the code-conventions-linting branch Jul 29, 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

3 participants