Cleanup contributing copy and streamline repo styling #762
Conversation
⏱️ 4h 53m total CI duration on this PR
|
| 2. Create a directory inside `linters/` with the name of your new linter. | ||
| 3. Inside this new directory, create the following structure. Most of these files will be | ||
| automatically created for you: | ||
| 2. Run `mkdir linters/<my-linter>` to start. This should autopopulate with a sample |
There was a problem hiding this comment.
Do you have to run this before check finishes? I think this is the part I missed 😆
There was a problem hiding this comment.
Really trunk check here is just a shorthand for launching our daemon, which listens for file changes in order to run Trunk Actions. trunk check should finish almost immediately if you're starting from a fresh checkout.
Running mkdir after that (>=1-2 seconds after the trunk check command starts) should be sufficient. But if you ran something like code linters/vale/plugin.yaml, the script won't autogen since it only checks empty directories :)
There was a problem hiding this comment.
We have trunk daemon start that just stats the daemon.
There was a problem hiding this comment.
I prefer having trunk check here in the documentation just to normalize standard usage
|
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 |
|
@gewenyu99 Thanks for the feedback! I'll update this to make sure that info is more discoverable! |
| 2. Create a directory inside `linters/` with the name of your new linter. | ||
| 3. Inside this new directory, create the following structure. Most of these files will be | ||
| automatically created for you: | ||
| 2. Run `mkdir linters/<my-linter>` to start. This should autopopulate with a sample |
There was a problem hiding this comment.
We have trunk daemon start that just stats the daemon.
README.md,CONTRIBUTING.md, andtests/README.mdto only focus on the important points and self-reference each other more clearlynodelinterdefinition-checkerthat enforces stylistic choices in the repo and recommends conventionsdescriptionandsuggest_ifsetCONTRIBUTING.md