plugins
plugins copied to clipboard
Cleanup contributing copy and streamline repo styling
- Updates and streamlines the copy for
README.md,CONTRIBUTING.md, andtests/README.mdto only focus on the important points and self-reference each other more clearly- Also underscores the autogen feature (requires a daemon launch)
- Replaces some of the repo tests with a
nodelinterdefinition-checkerthat enforces stylistic choices in the repo and recommends conventions- Validates no linters/tools/actions are explicitly enabled
- Ensures linters have
descriptionandsuggest_ifset - Ensures all linters have a relevant test file
- Fixes those conventions with a few places that fell through the cracks
- Extracts out the codegen into separate template files and reference them from
CONTRIBUTING.md
⏱️ 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) |
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 Thanks for the feedback! I'll update this to make sure that info is more discoverable!