docs(contrib): overhaul CONTRIBUTING.md accuracy and completeness#3409
Open
Borda wants to merge 5 commits into
Open
docs(contrib): overhaul CONTRIBUTING.md accuracy and completeness#3409Borda wants to merge 5 commits into
Borda wants to merge 5 commits into
Conversation
- Add metric implementation checklist: functional helpers, module class, task-triple pattern, exports, optional-dep guard, MetricTester - Fix dev install command (was missing `-e .` and used wrong requirements file) - Fix test commands to match src layout (two-step cd src/cd tests instead of single broken invocation) - Add DDP test invocation (USE_PYTEST_POOL) and MetricTester explanation - Fix Python version: 3.7 + PL reference → 3.10+ required - Fix docstring example: Return → Returns, Optional[float] → float | None, drop unused typing import - Fix docs path: _docs/build/html → docs/build/html, consolidate duplicate paragraph - Replace stale PR #98 link with implement.html guide - Fix typo: "How to we" → "How do we" --- Co-authored-by: Claude Code <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates .github/CONTRIBUTING.md to better reflect the current TorchMetrics development workflow, especially around implementing new metrics, setting up a dev environment, and running tests/docs locally.
Changes:
- Replaces a stale “example PR” link with the official “implementing a metric” guide and adds a metric implementation checklist.
- Updates developer setup and testing instructions (editable install with dev requirements; includes DDP test invocation and
MetricTesternotes). - Refreshes documentation guidance and style examples (Python 3.10+ typing syntax, docstring section naming, and HTML build inspection instructions).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
-e .and used wrong requirements file)Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃