docs(contributing): clarify fork and lint workflow - #302
Open
ooooo-create wants to merge 1 commit into
Open
Conversation
# 📝 Documentation - Explain how to fork Relax, clone the fork, and open a PR against upstream main in CONTRIBUTING.md and both contribution guides. - Add the pre-commit installation command to development setup. - Replace the Black, isort, and Flake8 commands in the English and Chinese guides with pre-commit checks. ## Validation - Pass pre-commit run --all-files --show-diff-on-failure using a temporary python alias to the installed python3. - Skip multi-node GPU integration tests because this change only updates documentation.
ooooo-create
requested review from
NINGBENZHE,
Yangruipis and
yxyOo
as code owners
September 7, 2026 15:14
There was a problem hiding this comment.
🟡 Changes recommended
The docs should complete the pre-commit setup (pre-commit install) and avoid hardcoded branch names in git push examples to prevent copy/paste failures.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the contribution documentation to reflect the repo’s current workflow: contributors should fork before cloning, and use the repo’s pre-commit configuration (instead of the previously documented Black/isort/Flake8 commands).
Changes:
- Document the fork → clone → branch → push-to-fork → PR flow across CONTRIBUTING.md and both language guides.
- Add pre-commit installation instructions and standardize on
pre-commit run --all-filesfor lint/format checks. - Keep English and Chinese guides aligned on the updated steps.
File summaries
| File | Description |
|---|---|
docs/zh/guide/how-to-contribute.md |
Updates Chinese contributing guide with fork-based workflow and pre-commit-based lint/format instructions. |
docs/en/guide/how-to-contribute.md |
Updates English contributing guide with fork-based workflow and pre-commit-based lint/format instructions. |
CONTRIBUTING.md |
Clarifies top-level contributing steps for external contributors (fork workflow + pre-commit). |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 6
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+60
to
+61
| # Install pre-commit | ||
| pip install pre-commit |
| Push your branch to your fork: | ||
|
|
||
| ```bash | ||
| git push origin feature/your-feature-name |
Comment on lines
+26
to
+27
| # Install pre-commit | ||
| pip install pre-commit |
Comment on lines
115
to
116
| # Push to your fork | ||
| git push origin feature/your-feature-name |
Comment on lines
+26
to
+27
| # 安装 pre-commit | ||
| pip install pre-commit |
Comment on lines
115
to
116
| # 推送到您的 fork | ||
| git push origin feature/your-feature-name |
SigureMo
reviewed
Sep 7, 2026
| ### 1. 设置开发环境 | ||
|
|
||
| 创建虚拟环境并安装依赖： | ||
| 先将 [redai-studio/Relax](https://github.com/redai-studio/Relax) **Fork** 到自己的账号，再执行以下命令（将 `<your_user_name>` 替换为您的 GitHub 用户名）： |
Collaborator
There was a problem hiding this comment.
Suggested change
| 先将 [redai-studio/Relax](https://github.com/redai-studio/Relax) **Fork** 到自己的账号，再执行以下命令（将 `<your_user_name>` 替换为您的 GitHub 用户名）： | |
| 先将 [redai-studio/Relax](https://github.com/redai-studio/Relax) **Fork** 到自己的账号，再执行以下命令（将 `<your_user_name>` 替换为你的 GitHub 用户名）： |
社区一般不需要使用「您」
| pip install -e . | ||
|
|
||
| # 安装 pre-commit | ||
| pip install pre-commit |
Collaborator
There was a problem hiding this comment.
pre-commit 安装是不是放在 format and lint 那块比较合适？
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
Complete the fork-to-PR workflow in
CONTRIBUTING.mdand the English and Chinese contribution guides. Add pre-commit installation instructions and replace the guides' outdated Black, isort, and Flake8 commands withpre-commit run --all-files.Why
The guides clone the upstream repository directly, leaving external contributors without a writable push destination. The formatting instructions also differ from the repository's current pre-commit configuration.
How
Explain how to fork and clone the repository, push a named branch to the fork, and open a PR against
redai-studio/Relax:main. Keep the English and Chinese instructions aligned.Testing
pre-commit run --all-filespasses (run with--show-diff-on-failure; a temporarypythonalias pointed to the installedpython3).pytest tests/) — not run: documentation-only changes; integration tests require multi-node GPU hardware.Also verified
git diff --checkand matching command examples in the English and Chinese guides.Type of Change
Screenshots / Logs
Not applicable.