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

docs: expand developer documentation #1956

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

espy
Copy link

@espy espy commented Jun 20, 2024

  • Add more documentation for local development, testing, linting and formatting

@espy espy requested a review from a team as a code owner June 20, 2024 12:57
@espy espy closed this Jun 20, 2024
@espy
Copy link
Author

espy commented Jun 25, 2024

Sorry, opened this too soon, now it’s really open :)

@espy espy reopened this Jun 25, 2024
Copy link
Member

@jaimergp jaimergp left a comment

Choose a reason for hiding this comment

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

Thanks! Just some minor changes about the text and what workflow we recommend.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@espy
Copy link
Author

espy commented Jun 26, 2024

Thanks so much for the quick feedback, I’ve accepted your suggestions, will change the python version change command, remove the other bits and clean up the commit history.

@espy espy force-pushed the docs/expand-developer-documentation branch from 7d46bf0 to d4e5828 Compare June 26, 2024 08:39
This was referenced Jul 12, 2024
README.md Outdated
-----------------------

To develop conda smithy, use your favortite conda-based environment manager and create an environment based on the `environment.yml`.
If you don’t already have a conda-based environment manager, install one. For example [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/).
Copy link
Member

Choose a reason for hiding this comment

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

Can you refer to miniforge here? https://github.com/conda-forge/miniforge

@wolfv
Copy link
Member

wolfv commented Jul 23, 2024

I added a comment to use the miniforge installer instead of miniconda. Miniforge is maintained by conda-forge and thus more appropriate for this use case :)

@hulkoba hulkoba force-pushed the docs/expand-developer-documentation branch from f6dabce to 82d9584 Compare August 23, 2024 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants