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: Link global ignores section in config object property list #18430

Merged

Conversation

MaoShizhong
Copy link
Contributor

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 autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

In the property list for Configuration Objects, added a link to Globally ignoring files with ignores in the description for the ignores property.

While this page has this section as well as a separate Ignore files page explaining this behaviour for global vs config object-specific ignore patterns, anyone reading the property list can easily miss the fact there is a different behaviour. This increases visibility of that behaviour, and links just like how Naming Convention is linked in the name description.

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

N/A

@MaoShizhong MaoShizhong requested a review from a team as a code owner May 7, 2024 20:03
Copy link

linux-foundation-easycla bot commented May 7, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: MaoShizhong (ffd402c)
  • ✅ login: nzakas / name: Nicholas C. Zakas (c052e67)

@eslint-github-bot
Copy link

Hi @MaoShizhong!, thanks for the Pull Request

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

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

Copy link

netlify bot commented May 7, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit c052e67
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/663b8675f959e20008ae3b78
😎 Deploy Preview https://deploy-preview-18430--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MaoShizhong MaoShizhong changed the title chore: Link global ignores section in config object property list chore: Link global ignores section in config object property list (docs) May 7, 2024
@eslint-github-bot
Copy link

Hi @MaoShizhong!, thanks for the Pull Request

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

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase
  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@MaoShizhong MaoShizhong changed the title chore: Link global ignores section in config object property list (docs) docs: Link global ignores section in config object property list May 7, 2024
@eslint-github-bot
Copy link

Hi @MaoShizhong!, thanks for the Pull Request

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

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@MaoShizhong MaoShizhong changed the title docs: Link global ignores section in config object property list docs: Link global ignores section in config object property list May 7, 2024
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label May 7, 2024
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks.

@nzakas nzakas merged commit e763512 into eslint:main May 8, 2024
15 checks passed
@MaoShizhong MaoShizhong deleted the chore/docs-link-global-ignores-section branch May 8, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

2 participants