Skip to content

Commit b4f9c54

Browse files
committed
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>
1 parent 914839f commit b4f9c54

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ pkg/
66
*~
77
vendor/
88
.DS_Store
9+
.venv
10+
venv

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,15 @@ require 'github/markup'
7272
GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two")
7373
```
7474

75+
Local Development
76+
-----------------
77+
78+
```sh
79+
python3 -m venv .venv
80+
source .venv/bin/activate
81+
cd script
82+
./bootstrap
83+
```
7584

7685
Contributing
7786
------------

0 commit comments

Comments
 (0)