search

conda / conda-lock

Lightweight lockfile for conda environments
https://conda.github.io/conda-lock/
Other
470 stars 102 forks source link

Step-By-Step Documentation #350

Open jesshart opened 1 year ago

jesshart commented 1 year ago

Checklist

What is the idea?

I am working on a step-by-step how-to document for conda-lock and I would like to donate all the time I've spent on it to the official documentation.

Why is this needed?

The existing documentation "gets the job done," but I would like to provide something for devs like me who are slower to get the idea regarding how a tool works.

What should happen?

I have already done a good deal of work testing my tutorial. My request would be that the community could help me review and we could publish it to the repo.

Additional Context

No response

maresb commented 1 year ago

Hey, this sounds excellent!!! Do you have a draft PR we could look at?

jesshart commented 1 year ago

Hey, this sounds excellent!!! Do you have a draft PR we could look at?

I love the enthusiasm! I will get a PR together asap. I have contributed a ton on teams using Bitbucket (i.e., elsewhere) so bare with me as I learn the ropes here.

jesshart commented 1 year ago

@maresb reviewed CONTRIBUTING.md and got up to the pytest command but I am unsure if I should proceed.

25 failed, 84 passed, 6 errors in 129.63s (0:02:09)

Is this expected or do I need to try again? I am using conda with libmamba which is not what the contributor docs call for.

I can try the mambaforge approach if needed. I was running into issues trying to use mamba as is.

maresb commented 1 year ago

If you're just doing doc-related stuff, don't worry so much about pytest. (It will anyways automatically run remotely in the CI after you push.)

If you want to debug pytest, then I'll need some details on the error messages.

jesshart commented 1 year ago

Alright! I forked, cloned, did the work, pushed it, and then requested a PR. I hope that was the right order of things.