Skip to content

docs: add website-eslint README.md #9873

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

Merged

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

This package hasn't been asked about much in the year and a half since I filed the docs request. I think just having a basic README.md that mentions the rough build flow & usage of it should be enough. Unless anybody has specific topics, which I'd love to know & add in here?

💖

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Aug 23, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8aa6339
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66cb52fb3caf1d00080df6af
😎 Deploy Preview https://deploy-preview-9873--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

@JoshuaKGoldberg JoshuaKGoldberg changed the title docs(website-eslint): add README.md docs: add website-eslint README.md Aug 23, 2024
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
bradzacher
bradzacher previously approved these changes Aug 24, 2024
@bradzacher bradzacher added documentation Documentation ("docs") that needs adding/updating 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labels Aug 24, 2024
Copy link

codecov bot commented Aug 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.03%. Comparing base (10b2ae3) to head (8aa6339).
Report is 28 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9873      +/-   ##
==========================================
- Coverage   88.04%   88.03%   -0.01%     
==========================================
  Files         407      407              
  Lines       13948    13941       -7     
  Branches     4078     4071       -7     
==========================================
- Hits        12280    12273       -7     
  Misses       1355     1355              
  Partials      313      313              
Flag Coverage Δ
unittest 88.03% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 15 files with indirect coverage changes

@JoshuaKGoldberg JoshuaKGoldberg merged commit 8b1eb00 into typescript-eslint:main Aug 30, 2024
57 of 59 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the website-eslint-readme branch August 30, 2024 12:06
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Document website-eslint
4 participants