Merge pull request #1872 from github/jm_add_venv_to_gitignore

chore: add .venv/venv to .gitignore and update README with local dev info
github · Sep 4, 2024 · 9fe4c64 · 9fe4c64
2 parents 914839f + b4f9c54
commit 9fe4c64
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@ pkg/
 *~
 vendor/
 .DS_Store
+.venv
+venv
diff --git 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
 ------------