HMCL-dev / HMCL-dev/HMCL

[Feature] [Doc] 更新贡献指导

Open
#6,602 9 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
10.1k
Forks
934
Avg merge
1d 5h
Merged PRs (30d)
82

Description

概述 | Summary

更新贡献指导,使其对 PR 的提出与推进具有约束与指导意义,并能成为维护者处理 spam PR 的根据。

原因 | Reason

现在的 Contributing.md 只是作为对环境配置和一些变量的介绍,对 PR 贡献不具有指导意义。同时随着 AI Code Agent 的发展,HMCL 仓库中涌现出一大批纯 vibe 的无效 PR,造成了一定困扰。

根据 #6598 中的讨论,我认为,无论是否将 AI spam 看作恶意的、无论要针对其采取何种措施,对贡献指导进行与时俱进的更新都是必要的。这样能够减少因标准不统一产生的争执,增强社区凝聚力。

详情 | Description

最后明确以上内容全都不是 AI 生成的,虽然我感觉我说话确实有点像 AI(((

欢迎各位积极讨论

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Contributing.md, then read the discussion in #6598 and the PR-format guidance in discussion #4921. Update the contribution guide to address vibe coding, expectations for feature, bug-fix, and refactor PRs, and the required PR format. Done means the guide provides consistent criteria for contributors and maintainers, including a basis for handling spam PRs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.