Skip to content

docs: update README files to add badge and instructions #20115

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 24, 2025
Merged

docs: update README files to add badge and instructions #20115

merged 3 commits into from
Sep 24, 2025

Conversation

lumirlumir
Copy link
Member

@lumirlumir lumirlumir commented Sep 14, 2025 •
edited
Loading

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 this PR, I've updated the README.md files in the packages.

The main changes are:

  1. I added badges, following the ones in the root-level README.md.

    eslint/README.md

    Lines 1 to 6 in 1ace67d

    [![npm version](https://img.shields.io/npm/v/eslint.svg)](https://www.npmjs.com/package/eslint)
    [![Downloads](https://img.shields.io/npm/dm/eslint.svg)](https://www.npmjs.com/package/eslint)
    [![Build Status](https://github.com/eslint/eslint/workflows/CI/badge.svg)](https://github.com/eslint/eslint/actions)
    <br>
    [![Open Collective Backers](https://img.shields.io/opencollective/backers/eslint)](https://opencollective.com/eslint)
    [![Open Collective Sponsors](https://img.shields.io/opencollective/sponsors/eslint)](https://opencollective.com/eslint)

  2. I updated the ESLint-related social links to match those in the root-level README.md.

    eslint/README.md

    Lines 10 to 19 in 1ace67d

    [Website](https://eslint.org) |
    [Configure ESLint](https://eslint.org/docs/latest/use/configure) |
    [Rules](https://eslint.org/docs/rules/) |
    [Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
    [Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
    [Code of Conduct](https://eslint.org/conduct) |
    [Twitter](https://twitter.com/geteslint) |
    [Discord](https://eslint.org/chat) |
    [Mastodon](https://fosstodon.org/@eslint) |
    [Bluesky](https://bsky.app/profile/eslint.org)

  3. I revised the installation guide to include yarn, pnpm, and bun as package managers.

    One of the installation guides originally used --save-dev, but for consistency, I've changed it to use -D.

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

N/A

@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Sep 14, 2025
@netlify Netlify
Copy link

netlify bot commented Sep 14, 2025 •
edited
Loading

✅ Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 8abdd62
🔍 Latest deploy log https://app.netlify.com/projects/docs-eslint/deploys/68d3acb3bef76e00088fdcd6
😎 Deploy Preview https://deploy-preview-20115--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 project configuration.

@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Sep 14, 2025
@lumirlumir lumirlumir marked this pull request as ready for review September 14, 2025 07:35
@lumirlumir lumirlumir requested a review from a team as a code owner September 14, 2025 07:35
@lumirlumir lumirlumir changed the title docs: update README files to enhance badge and instructions docs: update README files to add badge and instructions Sep 14, 2025
snitin315
snitin315 previously approved these changes Sep 19, 2025
View reviewed changes
Copy link
Contributor

@snitin315 snitin315 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. Leaving it open for others to review as well.

@snitin315 snitin315 added the accepted There is consensus among the team that this change meets the criteria for inclusion label Sep 19, 2025
@snitin315 snitin315 moved this from Needs Triage to Implementing in Triage Sep 19, 2025
aladdin-add
aladdin-add reviewed Sep 24, 2025
View reviewed changes
aladdin-add
aladdin-add reviewed Sep 24, 2025
View reviewed changes
aladdin-add
aladdin-add approved these changes Sep 24, 2025
View reviewed changes
Copy link
Member

@aladdin-add aladdin-add 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!

@aladdin-add aladdin-add merged commit 90a71bf into main Sep 24, 2025
30 checks passed
@aladdin-add aladdin-add deleted the docs-update-readme branch September 24, 2025 08:39
@github-project-automation github-project-automation bot moved this from Implementing to Complete in Triage Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aladdin-add aladdin-add aladdin-add approved these changes

@snitin315 snitin315 snitin315 left review comments

Assignees

No one assigned

Labels

accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation

Projects

Triage
Status: Complete

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lumirlumir @aladdin-add @snitin315