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

Updating contributing doc to add more detail on how to start #1185

Merged
merged 15 commits into from
Dec 11, 2024
Merged
8 changes: 6 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,12 @@ To contribute, you will first have to run through some steps:
- Set up your environment by forking the repository ((`Github doc on
forking and
cloning <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo>`__)).
- While at the root of your local copy of skrub, install the required
development dependencies by running
- Create a new virtual environment either with
Copy link
Contributor Author

@rcap107 rcap107 Dec 7, 2024

Choose a reason for hiding this comment

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

should I add the specific commands for both?

Copy link
Member

Choose a reason for hiding this comment

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

as they're quite short I would say yes, this one someone following along can just copy-paste without needing to follow the links

`venv <https://docs.python.org/3/library/venv.html>`__ or
`conda <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`__,
then activate it.
- While at the root of your local copy of skrub and within the new env,
install the required development dependencies by running
``pip install --editable ".[dev, lint, test, doc]"``.
- Run all the tests by running ``pytest -s skrub/tests``.
rcap107 marked this conversation as resolved.
Show resolved Hide resolved
- Run ``pre-commit install`` to activate some checks that will run every
Expand Down
Loading