rust-gamedev
Explain how to run lints locally on command line
The Style Guidelines mention:
- Run MarkdownLint against your changes with our config.
- Most editors have a MarkdownLint plugin available (e.g. VS Code, Sublime Text, Vim).
For those who don't have an IDE/editor with the plugin, would it be possible to list the commands necessary to install and run MarkdownLint againt the project's config? For example, something like
npm install markdownlint # or:
npm install markdownlint --save-dev
# then, explain how to run
This is less of an issue if the CI runs automatically on PRs -- which it seems to do for people who have contributed in the past.
Maybe this could also be wrapped in a .sh or .bash script (many Windows users have something like cmder or WSL2). As a bonus, in the future there could even be some custom automated checks for rules like "don't use bold/italics", "don't nest bullet points" or "use 3rd person instead of we/our/I/my".
Just writing down some thoughts, even the automated CI is already great 🙂
Big 👍 to this.
This is less of an issue if the CI runs automatically on PRs -- which it seems to do for people who have contributed in the past.
CI not running for new contributors is unfortunately a GitHub restriction (due to people doing malicious stuff with Actions, like making a PR with a cryptominer in it and using up other people's build quotas), so we can't do anything about this :(
Maybe this could also be wrapped in a .sh or .bash script (many Windows users have something like cmder or WSL2)
FWIW, I think an equal (if not greater) number of people use plain CMD or PowerShell, so if we go this route it might be worth providing a .bat as well, just so everyone's covered. I don't imagine these scripts would be super complex, so the duplication wouldn't be too bad.
I think we could close this once #1480 is merged, since the checks are so relaxed now. Feel free to reopen if this is still a pain point :)
