Skip to content
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

Added extensions for virtual environments in .gitignore #2372

Merged
merged 8 commits into from
Aug 28, 2024
Merged

Added extensions for virtual environments in .gitignore #2372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ce6c1d9
References issue fixed
varuntotakura Aug 20, 2024
ce7f573
Changelog Created
varuntotakura Aug 20, 2024
aad274f
Link issue fix #2369
varuntotakura Aug 22, 2024
eb818c1
ignore virtual envs (2371)
varuntotakura Aug 24, 2024
90e649f
Add changelog for #2371
varuntotakura Aug 24, 2024
4cb9ad6
Revert "Add changelog for #2371"
varuntotakura Aug 24, 2024
5cbe0e8
Add changelog for #2371
varuntotakura Aug 24, 2024
90c4e75
Merge branch 'main' into #2371
varuntotakura Aug 24, 2024
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
7 changes: 7 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ var/
.ipynb_checkpoints
.virtual_documents

# Environments
.env
.venv
env/
venv/
ENV/

# PyInstaller
Comment on lines +32 to 38
Copy link
Contributor

Choose a reason for hiding this comment

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

Other options that come to my mind are

  • hatch.toml
  • pdm.lock
  • Pipfile.lock
  • Pipfile
  • poetry.lock`

I'm not completely sure if people should be building ArviZ following an approach different from the recommended one, but people can do whatever they want so it's probably good to have these files/directories listed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I believe it's important to use the recommended approaches. However, when installing dependencies, some may prefer to use a virtual environment. While it’s important to track the core dependency and configuration files like Pipfile, Pipfile.lock, poetry.lock, pdm.lock, and hatch.toml in version control, it’s equally important to ignore files and directories that are specific to individual developers' environments, such as virtual environments. These files are not relevant to other people's builds and can clutter the repository.

# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
### Deprecation

### Documentation
- Added extensions of virtual environments in [.gitignore](https://github.com/arviz-devs/arviz/blob/main/.gitignore) ([2371](https://github.com/arviz-devs/arviz/issues/2371))
- Fixed the issue in the [Contribution References Documentation](https://python.arviz.org/en/latest/contributing/index.html) ([2369](https://github.com/arviz-devs/arviz/issues/2369))

## v0.19.0 (2024 Jul 19)
Expand Down