From 8fa593c11125d6b0abe6384e676e7bb4c3c7ea8d Mon Sep 17 00:00:00 2001
From: Hendrik Eeckhaut <hendrik@eeckhaut.org>
Date: Mon, 19 Aug 2024 14:43:43 +0200
Subject: [PATCH] doc: added note about "format on save" to the contribution
 guide

---
 CONTRIBUTING.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 725f2eee1..1cc4da3af 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,6 +18,8 @@ Try to do one pull request per change.
 
 ## Style
 
+This repository includes a `rustfmt.toml` file with custom formatting settings that are automatically validated by CI before any Pull Requests (PRs) can be merged. To ensure your code adheres to these standards, format your code using this configuration before submitting a PR. We strongly recommend enabling *auto format on save* to streamline this process. In Visual Studio Code (VSCode), you can enable this feature by turning on [`editor.formatOnSave`](https://code.visualstudio.com/docs/editor/codebasics#_formatting) in the settings.
+
 ### Capitalization and punctuation
 
 Both line comments and doc comments must be capitalized. Each sentence must end with a period.