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 Improvement] Add Linting Cheatsheet to Linting.md #7571

Merged
merged 3 commits into from
May 1, 2024

Conversation

gdjohnson
Copy link
Contributor

@burtonator wrote a cheatsheet for handling common linting issues.

I've integrated that cheatsheet with our current knowledge base entry, Linting.md. Some (relatively minor) changes were made to the cheatsheet's contents, either to (1) remove redundancies with the existing documentation, (2) reorganize information from the cheatsheet into another, more relevant section of the entry, or (3) bring it in line stylistically with the knowledge base. Nothing major, but just flagging this explicitly @burtonator so you're aware, and scan over it accordingly!

I've also reviewed and refreshed the existing documentation on linting and formatting to the best of my knowledge—however, I don't use these tools day in and day out, so I'd welcome eyes from @masvelio, @kurtisassad or any other team member. (Picking on you two since you've expressed opinions in the past...)

Link to Issue

Closes: #7537

Description of Changes

  • Reorganizes the entry into two main sections, one on eslint and one on prettier, plus the cheatsheet
  • A few lines acknowledging the recent introduction of eslint-diff plugin—@burtonator, if the inclination strikes you, feel free to suggest more language/info here

"Deployment Plan"

Will mark as "Certified Fresh" in the change log once I get some approvals / feedback.

@gdjohnson gdjohnson added the documentation Improvements or additions to documentation label Apr 25, 2024
@gdjohnson gdjohnson requested a review from burtonator April 25, 2024 19:32
@jnaviask jnaviask merged commit 20a22ff into master May 1, 2024
10 checks passed
@jnaviask jnaviask deleted the 7537.graham.linter-cheatsheet branch May 1, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Improvement] Add Linter Cheatsheet to Knowledge Base & Review Linting.md
3 participants