hicommonwealth / commonwealth

A platform for decentralized communities
https://commonwealth.im
GNU General Public License v3.0
65 stars 38 forks source link

[Docs Improvement] Add Linting Cheatsheet to Linting.md #7571

Closed gdjohnson closed 1 week ago

gdjohnson commented 2 weeks ago

@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

"Deployment Plan"

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