diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d55c1da7..1d3de9e1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,36 @@ try to follow these guidelines when you do so. * Ensure your edited codes with four spaces instead of TAB. * About how to make a package, please see [Create and Submit packages to the official repository](https://xmake.io/#/package/remote_package?id=submit-packages-to-the-official-repository) +# Package maintainers + +## Work to be done + +Review the pull requests submitted by contributors + - Check for commits to dev branches, master branches are not allowed to be directly committed and merged + - Check that the code conforms to the specification + - Check that the on_test script is added and that the ci test passes + - Help contributors with difficult ci testing issues where possible + - Check that the code is lean and remind contributors to remove redundant code and keep the on_test script as lean as possible and not too long +Merge pull requests on dev branches that pass the tests + +## Other points to note + +1. don't have any commits to the master branch +2. ci will periodically sync commits from the dev branch to the master branch and other mirror repositories every hour +3. packages must be merged using `Squash and merge` mode to avoid overly redundant commit records + +## How do I become a package maintainer? + +First you need to meet the following requirements: + +- Have committed at least 10 packages that have been successfully merged into the xmake-repo repository +- Have helped review at least 3 other contributors' commits and provided valuable input +- Submitted packages that are recognised by existing package maintainers for their quality +- Have sufficient free time and energy and be passionate about xmake package maintenance +- Be familiar with the use of xmake and the full process of creating xmake packages + +If you feel you meet the above requirements, you can apply to become a package maintainer by emailing waruqi@gmail.com. + # 贡献代码 如果你发现一些问题或者想贡献一个新的包 @@ -44,3 +74,33 @@ try to follow these guidelines when you do so. * 关于如何制作包,请参看文档:[制作和提交到官方仓库](https://xmake.io/#/zh-cn/package/remote_package?id=%e6%b7%bb%e5%8a%a0%e5%8c%85%e5%88%b0%e4%bb%93%e5%ba%93) [1]: https://github.com/xmake-io/xmake-repo/issues + +# 包维护者 + +## 需要做的工作 + +1. Review 贡献者提交的 pull request + - 检查是否提交到 dev 分支,master 分支是不允许被直接提交和合并的 + - 检查代码所以是否符合规范 + - 检查是否添加 on_test 脚本,并且 ci 测试是否通过 + - 尽可能帮助贡献者解决 ci 测试过程中遇到的一些疑难问题 + - 检查代码是否精简,提醒贡献者去除冗余代码,on_test 脚本尽可能保持精简,不要太长 +2. 合并 dev 分支上通过测试的 pull request + +## 其他注意点 + +1. 不要有任何到 master 分支的提交 +2. ci 每个小时会定期将 dev 分支的提交同步到 master 分支以及其他镜像仓库 +3. 必须使用 `Squash and merge` 模式合并包,避免过于冗余的提交记录 + +## 如何成为包维护者? + +首先你需要满足以下要求: + +- 至少提交过 10 个包,并成功合并入 xmake-repo 仓库 +- 至少帮助 Review 过 3 个其他贡献者提交的包,并提出有价值的意见 +- 提交的包质量得到现有包维护者的认可 +- 有足够的空闲时间和精力,对 xmake 包维护充满热情 +- 熟悉 xmake 的使用,以及 xmake 包的完整制作过程 + +如果你觉得满足上述要求,可以发送邮件到 waruqi@gmail.com 去申请成为包维护者。