plugins icon indicating copy to clipboard operation
plugins copied to clipboard

Cleanup contributing copy and streamline repo styling

Open TylerJang27 opened this issue 1 year ago • 3 comments

  1. Updates and streamlines the copy for README.md, CONTRIBUTING.md, and tests/README.md to only focus on the important points and self-reference each other more clearly
    • Also underscores the autogen feature (requires a daemon launch)
  2. Replaces some of the repo tests with a node linter definition-checker that enforces stylistic choices in the repo and recommends conventions
    • Validates no linters/tools/actions are explicitly enabled
    • Ensures linters have description and suggest_if set
    • Ensures all linters have a relevant test file
  3. Fixes those conventions with a few places that fell through the cracks
  4. Extracts out the codegen into separate template files and reference them from CONTRIBUTING.md

TylerJang27 avatar Apr 30 '24 08:04 TylerJang27

⏱️ 4h 53m total CI duration on this PR
Job Cumulative Duration Recent Runs
Linter Tests ubuntu-latest 1h 43m 🟩🟩🟩 (+1 more)
Linter Tests macOS 1h 11m 🟩🟩🟩 (+1 more)
Tool Tests (ubuntu-latest) 37m 🟩🟩🟩🟩 (+1 more)
Windows Linter Tests 27m 🟩🟩🟩🟩🟩 (+1 more)
Tool Tests (macOS) 23m 🟩🟩🟩🟩🟩 (+1 more)
Trunk Check runner [linux] 10m 🟩🟩🟩🟩🟩 (+1 more)
CodeQL-Build 10m 🟩🟩🟩🟩🟩 (+1 more)
Action Tests 9m 🟩🟩🟩🟩🟩 (+1 more)
Repo Tests / Plugin Tests 3m 🟩🟩🟩🟩🟩 (+1 more)
Detect changed files 51s 🟩🟩🟩🟩🟩 (+1 more)
Aggregate Test Results 13s 🟥🟥🟩🟩🟩 (+1 more)

settingsfeedbackdocs ⋅ learn more about trunk.io

trunk-io[bot] avatar Apr 30 '24 08:04 trunk-io[bot]

Nice :D ❤️ This would definitely be helpful for the next contributor.

I think the only other thing that took me some time to figure out was all the temporary folders generated when a tool's downloaded/when tests are running locally.

They were useful to check when things didn't act like I'd expect. Would be nice if smwhere in contributing we can point in the general direction. I happened to find them just by some weird greps I tried running.

gewenyu99 avatar May 02 '24 13:05 gewenyu99

@gewenyu99 Thanks for the feedback! I'll update this to make sure that info is more discoverable!

TylerJang27 avatar May 02 '24 17:05 TylerJang27