From: rdrll <13176405+rdrll@users.noreply.github.com>
Date: Tue, 18 Jul 2023 21:11:24 +0000 (-0700)
Subject: Improvements to contributing docs (#3753)
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/0b301f80954a026693c4c22de89267ad8c85f9b6

Improvements to contributing docs (#3753)
---

diff --git a/docs/contributing/the_basics.md b/docs/contributing/the_basics.md
index 5fdcdd8..40d2332 100644
--- a/docs/contributing/the_basics.md
+++ b/docs/contributing/the_basics.md
@@ -12,7 +12,9 @@ example:
 
 ```console
 $ python3 -m venv .venv
-$ source .venv/bin/activate
+$ source .venv/bin/activate # activation for linux and mac
+$ .venv\Scripts\activate # activation for windows
+
 (.venv)$ pip install -r test_requirements.txt
 (.venv)$ pip install -e .[d]
 (.venv)$ pre-commit install
@@ -30,6 +32,9 @@ the root of the black repo:
 
 # Optional Fuzz testing
 (.venv)$ tox -e fuzz
+
+# Format Black itself
+(.venv)$ tox -e run_self
 ```
 
 ### News / Changelog Requirement
@@ -62,7 +67,7 @@ If you make changes to docs, you can test they still build locally too.
 
 ```console
 (.venv)$ pip install -r docs/requirements.txt
-(.venv)$ pip install [-e] .[d]
+(.venv)$ pip install -e .[d]
 (.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
 ```