From b4f9c54a4b4c117cb315cd0f4df09ffd5a1484b7 Mon Sep 17 00:00:00 2001
From: jmeridth <jmeridth@gmail.com>
Date: Wed, 4 Sep 2024 15:06:15 -0500
Subject: [PATCH] chore: add .venv/venv to .gitignore

best practices with local python development is to create a virtual
environment.  The most common are either .venv or venv folders in
the root of the repo.

We currently install [docutils](https://github.com/github/markup/blob/914839fd31c93b93a8054a3c91fce0906b2d1375/script/bootstrap#L8)
via pip (python).

- [x] add .venv/venv folders to .gitignore
- [x] update README with how to setup locally environment

Signed-off-by: jmeridth <jmeridth@gmail.com>
---
 .gitignore | 2 ++
 README.md  | 9 +++++++++
 2 files changed, 11 insertions(+)

diff --git a/.gitignore b/.gitignore
index eac4d715..b0f0821c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,5 @@ pkg/
 *~
 vendor/
 .DS_Store
+.venv
+venv
diff --git a/README.md b/README.md
index b2bcc809..3aeb7110 100644
--- a/README.md
+++ b/README.md
@@ -72,6 +72,15 @@ require 'github/markup'
 GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two")
 ```
 
+Local Development
+-----------------
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+cd script
+./bootstrap
+```
 
 Contributing
 ------------