Update Contributing Guide to add info about EditorConfig

Alyssa Rock · Thomas Phipps · commit 2cb15231758a · 2022-02-23T22:53:13.000Z
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -44,6 +44,9 @@ This repository uses the following tools:
 * GitLab handles the
   `CI/CD pipeline <https://gitlab.com/saltstack/open/docs/salt-user-guide/-/pipelines>`__
   for the project.
+* `EditorConfig <https://editorconfig.org/>`__ is an optional tool you can use
+  with your preferred editor to ensure that you follow the Salt Project coding
+  guidelines.
 
 
 Overview of how to contribute to the Salt User Guide repository
@@ -170,6 +173,17 @@ Create new branch for changes to submit:
     git checkout -b my-new-feature
 
 
+Configure your editor (optional)
+================================
+`EditorConfig <https://editorconfig.org/>`__ is an optional tool you can use
+with your preferred code/text editor to ensure that you follow the Salt Project
+coding and style guidelines. To enable EditorConfig, check the compatibility
+and configuration settings for your preferred code/text editor.
+
+Using EditorConfig is optional for contributing to this repository, but
+recommended.
+
+
 Set up your local preview environment
 =====================================
 If you are not on a Linux machine, you need to set up a virtual environment to
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,6 @@
 Sphinx-Substitution-Extensions>=2020.9.30.0
 furo
 sphinx-copybutton>=0.3.1
+sphinx-prompt
 sphinx-tabs>=2.0.0
 sphinx>=4.1.2
