docs: Minor improvements to contributing guide

docs/development/contributing/index.md

@@ -95,6 +95,10 @@ cd py-polars
 make test
 ```
 
+!!! note
+
+    You need to have [CMake](https://cmake.org/) installed for `make test` to work.
+
 This will do a number of things:
 
 - Use Python to create a virtual environment in the `.venv` folder.
@@ -176,22 +180,24 @@ Two other things to keep in mind:
 When you have resolved your issue, [open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) in the Polars repository.
 Please adhere to the following guidelines:
 
-- Title
-  - Start your pull request title with a [conventional commit](https://www.conventionalcommits.org/) tag.
-    This helps us add your contribution to the right section of the changelog.
-    We use the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type).
-    Scope can be `rust` and/or `python`, depending on your contribution: this tag determines which changelog(s) will include your change.
-    Omit the scope if your change affects both Rust and Python.
-  - Use a descriptive title starting with an uppercase letter.
-    This text will end up in the [changelog](https://github.com/pola-rs/polars/releases), so make sure the text is meaningful to the user.
-    Use single backticks to annotate code snippets.
-    Use active language and do not end your title with punctuation.
-  - Example: ``fix(python): Fix `DataFrame.top_k` not handling nulls correctly``
-- Description
-  - In the pull request description, [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to the issue you were working on.
-  - Add any relevant information to the description that you think may help the maintainers review your code.
+<!-- dprint-ignore-start -->
+- Title:
+    - Start your pull request title with a [conventional commit](https://www.conventionalcommits.org/) tag.
+      This helps us add your contribution to the right section of the changelog.
+      We use the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type).
+      Scope can be `rust` and/or `python`, depending on your contribution: this tag determines which changelog(s) will include your change.
+      Omit the scope if your change affects both Rust and Python.
+    - Use a descriptive title starting with an uppercase letter.
+      This text will end up in the [changelog](https://github.com/pola-rs/polars/releases), so make sure the text is meaningful to the user.
+      Use single backticks to annotate code snippets.
+      Use active language and do not end your title with punctuation.
+    - Example: ``fix(python): Fix `DataFrame.top_k` not handling nulls correctly``
+- Description:
+    - In the pull request description, [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to the issue you were working on.
+    - Add any relevant information to the description that you think may help the maintainers review your code.
 - Make sure your branch is [rebased](https://docs.github.com/en/get-started/using-git/about-git-rebase) against the latest version of the `main` branch.
 - Make sure all [GitHub Actions checks](./ci.md) pass.
+<!-- dprint-ignore-end -->
 
 After you have opened your pull request, a maintainer will review it and possibly leave some comments.
 Once all issues are resolved, the maintainer will merge your pull request, and your work will be part of the next Polars release!
@@ -210,6 +216,7 @@ The user guide is maintained in the `docs/user-guide` folder. Before creating a
 #### Building and serving the user guide
 
 The user guide is built using [MkDocs](https://www.mkdocs.org/). You install the dependencies for building the user guide by running `make build` in the root of the repo.
+Additionally, you need to make sure the [graphviz](https://graphviz.org/) `dot` binary is on your path.
 
 Activate the virtual environment and run `mkdocs serve` to build and serve the user guide, so you can view it locally and see updates as you make changes.
 

mkdocs.yml

@@ -143,6 +143,7 @@ theme:
     - navigation.footer
     - navigation.indexes
     - content.tabs.link
+    - content.code.copy
   icon:
     repo: fontawesome/brands/github