Skip to content

CONTRIBUTING: Make virtualenv dir name consistent with gitignore #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2020
Merged

CONTRIBUTING: Make virtualenv dir name consistent with gitignore #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
dist
docs/_build
build/
venv/
/venv*/
Copy link
Member

@sigmavirus24 sigmavirus24 Jan 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the leading slash correct here? Should it just be venv*/ This isn't a regular expression, it's a glob (I thought)

Copy link
Contributor Author

@EricCousineau-TRI EricCousineau-TRI Jan 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The leading slash in .gitignore implies that it should only match venv*/ directories that directly neighbor the .gitignore file.

e.g. it will ignore pycodestyle/venv-biscuit/, but not pycodestyle/docs/venv-cookie.

Copy link
Contributor Author

@EricCousineau-TRI EricCousineau-TRI Jan 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citing da sources:
https://git-scm.com/docs/gitignore#_pattern_format

A leading slash matches the beginning of the pathname. For example, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c".

6 changes: 4 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ Next, ``cd`` to the pycodestyle repository that you cloned earlier and
create, then activate a virtualenv::

$ cd pycodestyle
$ virtualenv pycodestyle-venv
$ source pycodestyle-venv/bin/activate
$ virtualenv venv-pycodestyle
$ source venv-pycodestyle/bin/activate

Note that ``venv*/`` is ignored via ``.gitignore``.

Now you can install the pycodestyle requirements::

Expand Down