Update contributor docs: CoC 2.1, completeness, link fixes#21614
Open
Update contributor docs: CoC 2.1, completeness, link fixes#21614
Conversation
- Upgrade CODE_OF_CONDUCT.md from Contributor Covenant 1.4 to 2.1 (tiered enforcement ladder, expanded pledge) - Add project conventions section to CONTRIBUTING.md (line length, Ruff rules, MyPy, rank_zero_*, callback hook convention) - Add two-package architecture overview and Python 3.9+ requirement to CONTRIBUTING.md - Fix broken/dead links in CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md - Rewrite tests/README.md: test layout tree, RunIf decorator, markers, standalone tests, coverage commands for both packages --- Co-authored-by: Claude Code <noreply@anthropic.com>
Borda
requested review from
ethanwharris,
justusschock,
lantiga,
tchaton and
williamFalcon
as code owners
for more information, see https://pre-commit.ci
Contributor
⚡ Required checks status: All passing 🟢No groups match the files changed in this PR. Thank you for your contribution! 💜
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation refresh for contributors and maintainers, updating community guidelines, contributor conventions, and test-running instructions to reflect the repo’s current structure and CI expectations.
Changes:
- Updated Code of Conduct to Contributor Covenant v2.1 with enforcement guidelines.
- Expanded CONTRIBUTING.md with repo architecture and contributor conventions (linting, typing, rank-aware utilities, callback-hook process).
- Reworked tests/README.md with new test layout, RunIf usage, coverage commands, and updated local/CI guidance; fixed template link(s).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
tests/README.md |
Rewrites test documentation (layout, commands, RunIf/markers/standalone/coverage). |
.github/PULL_REQUEST_TEMPLATE.md |
Updates documentation links used in PRs. |
.github/CONTRIBUTING.md |
Adds repo architecture + conventions (lint/type/rank-aware/callback-hook guidance). |
.github/CODE_OF_CONDUCT.md |
Upgrades CoC content to Contributor Covenant 2.1 (incl. enforcement ladder). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
[resolve #2] Review comment by @Copilot (PR #21614): "These commands run run_standalone_tasks.sh from the tests/ directory, but the script explicitly assumes it is run with the working directory tests/tests_pytorch and uses relative paths that will fail otherwise." --- Co-authored-by: Claude Code <noreply@anthropic.com>
[resolve #5] Review comment by @Copilot (PR #21614): "Consider linking to the contributing guide in the current repo (preferably via a relative link) to avoid sending reviewers to a potentially different/outdated document." --- Co-authored-by: Claude Code <noreply@anthropic.com>
justusschock
approved these changes
Mar 30, 2026
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?
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--21614.org.readthedocs.build/en/21614/