Skip to content

docs: Improve CONTRIBUTING.md#579

Merged
ValerianRey merged 2 commits intomainfrom
improve-contributing
Feb 18, 2026
Merged

docs: Improve CONTRIBUTING.md#579
ValerianRey merged 2 commits intomainfrom
improve-contributing

Conversation

@ValerianRey
Copy link
Contributor

@ValerianRey ValerianRey commented Feb 18, 2026

  • Rename torchjd to TorchJD when referring to the repo
  • Fix typo
  • Restructure the file
  • Add explanation about PYTHONPATH
  • Suggest rm -f for uv.lock (otherwise we often have a warning saying the file doesn't exist)
  • Add tip about code coverage
  • Change desired code coverage value from ~95-100% to 100%. Also explain that we appreciate PRs with insufficient coverage.
  • Fix outdated example with import from device.py
  • Improve explanation of partial functions to create tensors
  • Add README verification step in the release section

* Rename torchjd to TorchJD when referring to the repo
* Fix typo
* Restructure the file
* Add explanation about PYTHONPATH
* Suggest rm -f for uv.lock (otherwise we often have a warning saying the file doesn't exist)
* Add tip about code coverage
* Change desired code coverage value from ~95-100% to 100%. Also explain that we appreciate PRs with insufficient coverage.
* Fix outdated example with import from device.py
* Improve explanation of partial functions to create tensors
* Add README verification step in the release section
@ValerianRey ValerianRey added the cc: docs Conventional commit type for changes to the documentation. label Feb 18, 2026
@ValerianRey ValerianRey self-assigned this Feb 18, 2026
@ValerianRey
Copy link
Contributor Author

@PierreQuinton should be smoother now. Nothing to change on your end I think.

@ValerianRey
Copy link
Contributor Author

@claude Please review this. In particular, check for typos in the entire CONFIGURING.md file, even in parts of the file that this PR doesn't touch. Also check that nothing that is said here is outdated.

@claude

This comment was marked as resolved.

@ValerianRey ValerianRey merged commit f872551 into main Feb 18, 2026
16 checks passed
@ValerianRey ValerianRey deleted the improve-contributing branch February 18, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cc: docs Conventional commit type for changes to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments