mv getting-started info to CONTRIBUTING.md

Author: 2bndy5

.github/workflows/run-dev-tests.yml

@@ -31,6 +31,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - run: rustup update --no-self-update
       - run: rustup component add llvm-tools-preview
 
       # https://docs.rs/openssl/latest/openssl/#automatic

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing
+
+This project requires the following tools installed:
+
+- :simple-rust: [rust](https://rustup.rs/)
+- :simple-uv: [`uv` (Python Project management tool)](https://docs.astral.sh/uv/)
+
+## Getting started
+
+After checking out the repo locally, use
+
+```sh
+uv sync
+```
+
+This creates a venv at ".venv/" in repo root (if it doesn't exist).
+It also installs dev dependencies like `pre-commit`, `nox`, `ruff`, and `mypy`.
+
+See [`uv sync` docs](https://docs.astral.sh/uv/reference/cli/#uv-sync)
+for more detailed usage.
+
+> [!TIP]
+> To register the pre-commit hooks, use:
+>
+> ```shell
+> uv run pre-commit install
+> ```
+
+## Running tests
+
+First ensure that the following cargo-managed binaries are installed:
+
+- [`cargo-llvm-cov`](https://github.com/taiki-e/cargo-llvm-cov)
+- [`cargo-nextest`](https://nexte.st/docs/installation/pre-built-binaries/)
+- [`llvm-cov-pretty`](https://crates.io/crates/llvm-cov-pretty) is used only for the optional `nox -s pretty-cov` task. Without this installed, `nox -s llvm-cov` will suffice.
+
+Use nox to run tests:
+
+```sh
+uv run nox -s test
+```
+
+Different test profiles are still defined in .config/nextest.toml.
+The above command uses the "default" profile, but to mimic the CI, use:
+
+```sh
+uv run nox -s test -- --profile ci
+```
+
+To generate a coverage report:
+
+```sh
+uv run nox -s llvm-cov -- --open
+```
+
+The `-- --open` part is optional. It opens the built coverage report in your default browser.
+
+The uploaded codecov report is generated with
+
+```sh
+uv run nox -s lcov
+```
+
+## Generating docs
+
+To view the docs locally, use
+
+```sh
+uv run nox -s docs -- --open
+```
+
+The `-- --open` part is optional. It opens the built docs in your default browser.
+
+In CI, docs are built using
+
+```sh
+uv run nox -s docs-build
+```

docs/README.md

@@ -4,16 +4,11 @@ This folder is only for generating the documentation about CLI and runtime permi
 Please [visit our website][gh-pages] to see generated documentation.
 
 [gh-pages]: https://cpp-linter.github.io/cpp-linter-rs
-[uv]: https://docs.astral.sh/uv/
 
 ## Build and inspect locally
 
 To view the documentation locally, some software needs to be installed.
-This project's dependencies are managed with a tool called [`uv`][uv].
-So, [`uv`][uv] is the only software that needs to be manually installed beforehand.
 
-After [`uv`][uv] is installed, building (and viewing) the docs is as simple as
-
-```shell
-uvx nox -s docs -- --open
-```
+> [!IMPORTANT]
+> Please review of [Contributing doc](docs/getting-started.md)
+> which contains instruction about building and inspecting docs.

docs/docs/contributing.md

@@ -0,0 +1,5 @@
+<!-- markdownlint-disable MD041 -->
+
+{%
+    include "../../CONTRIBUTING.md"
+%}

docs/mkdocs.yml

@@ -12,6 +12,7 @@ nav:
   - python.md
   - node.md
   - changelog.md
+  - contributing.md
   - other-licenses.md
 
 theme: