Skip to content

docs: Add setup suggestions in CONTRIBUTING.md #563

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

Merged
ValerianRey merged 1 commit into from
Feb 13, 2026
Merged

docs: Add setup suggestions in CONTRIBUTING.md #563

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ with maintainers before implementing major changes.

To work with TorchJD, we suggest you to use [uv](https://docs.astral.sh/uv/). While this is not
mandatory, we only provide installation steps with this tool. You can install it by following their
[installation documentation](https://docs.astral.sh/uv/getting-started/installation/).
[installation documentation](https://docs.astral.sh/uv/getting-started/installation/). We also
suggest to use VSCode with the `Python`, `ty` and `ruff` extensions (without `Pylance`).

1) Pre-requisites: Use `uv` to install a Python version compatible with TorchJD and to pin it to the
`torchjd` folder. From the root of the `torchjd` repo, run:
Expand Down