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.

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

Endorse a finite number of package managers and document how to use them for contributing, including limitations #741

Closed
mfisher87 opened this issue Jul 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mfisher87
Copy link
Collaborator

mfisher87 commented Jul 1, 2024

We have a conda dev environment specification, but we don't really document how to use it. For a pure python project, I expect pip install --editable .[dev,...], but we've set up our project for poetry development environment, and our contributing doc doesn't say how to use it. What package managers do we want to endorse / encourage and document for our contributors?

Limitations: For example, our environment-dev.yml isn't perfectly up to date. Let's document that or change the file so that it doesn't need to be kept up to date, as suggested by @jhkennedy here

Extracted from #449

@mfisher87 mfisher87 changed the title Limitations of conda vs poetry (e.g. conda dev environment specification doesn't include all docs dependencies) - IMO let's leave this for later. Endorse a finite number of package managers and document how to use them for contributing, including limitations Jul 1, 2024
@mfisher87 mfisher87 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 6, 2024
@itcarroll
Copy link
Collaborator

Can we say this is closed by #733, which blessed and documented nox, python -m venv, and conda?

@mfisher87
Copy link
Collaborator Author

I'm good with that :)

@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in earthaccess project Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants