From 21ef1151b3e65e9ab6a6c7bc9f36e3e328c07d87 Mon Sep 17 00:00:00 2001 From: TrialDragon <31419708+TrialDragon@users.noreply.github.com> Date: Tue, 5 Mar 2024 08:09:37 -0800 Subject: [PATCH] Update local CI running instructions for contributors (#1071) --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9daadd03b4..add8729238 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -175,7 +175,13 @@ These may be appropriate to link in "next steps" however at the end of the examp 1. Third-party crates should be limited to the most essential, such as `rand`. 9. If additional code block attributes like `no_run` or `hide-lines=x-y` need to be specified, you should always order these so that the language is the last attribute. If we would specify `rust,no_run` the syntax highlighting wouldn't work, but changing it to `no_run,rust` makes it work. 10. To validate if local code changes are compiling you can `cd` into the `code-validation` folder and test your code using `cargo test`. -11. To make sure your markdown files are formatted correctly run `markdownlint -f -c .github/linters/.markdown-lint.yml .` in the root directory of your local Bevy website repository. In order to run the command you should install `markdownlint-cli`. See: +11. To make sure your web-based files (html, markdown) are formatted correctly run the commands: + ``` + markdownlint -f -c .github/linters/.markdown-lint.yml . + djlint + typos + ``` + in the root directory of your local Bevy website repository. This will format markdown files and tell you the issues in HTML files. In order to run the command you should install `markdownlint-cli`, `djlint`, and `typos-cli`. See: , , and . Note that the CI also includes `editorconfigchecker` but there isn't an easy way to run this manually, so you should instead rely on CI to validate files with this tool. 12. To hide lines of code in Zola Rust code blocks of the book you should: a. Mark each line you wish to hide with a `#` with an empty space afterwards like `# //...line_of_code_here...` although you were hiding lines in rustdoc. b. Run the [utility tool](write-rustdoc-hide-lines) in `/write_rustdoc-hide-lines/` named `write_rustdoc_hide_lines.sh`. 13. To reference Rust API docs you can use markdown's reference-style links like so: [`HashMap`]