Skip to content

Commit 9ae3c0a

Browse files
committed
fix(docs): update contribution guidelines in README files
1 parent ab977d9 commit 9ae3c0a

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,12 @@ See the [Run the Server wiki](https://github.com/lcomplete/huntly/wiki/Run-the-S
120120

121121
## Contributing
122122

123-
> [!IMPORTANT]
124-
> All Pull Requests must target the `dev` branch.
123+
Contributions are welcome.
124+
125+
- Check existing issues and pull requests before starting to avoid duplicate work.
126+
- Open an issue or discussion first for larger changes so the approach can be aligned.
127+
- Keep pull requests focused and include a clear description, test notes, or screenshots when relevant.
128+
- Update related documentation and tests when your change affects behavior or user workflows.
125129

126130
## Become a Sponsor
127131

README.zh.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,12 @@ sudo xattr -r -d com.apple.quarantine /YOUR_PATH/Huntly.app
120120

121121
## 参与贡献
122122

123-
> [!IMPORTANT]
124-
> 所有 Pull Request 必须提交到 `dev` 分支。
123+
欢迎提交贡献。
124+
125+
- 开始之前先查看现有的 issue 和 pull request,避免重复工作。
126+
- 如果是较大的改动,建议先发起 issue 或 discussion,对齐方案后再开始。
127+
- 保持 pull request 聚焦,并在需要时补充清晰的说明、测试信息或截图。
128+
- 当改动影响功能行为或用户使用流程时,请同步更新相关文档和测试。
125129

126130
## 成为赞助者
127131

0 commit comments

Comments
 (0)