如题,欢迎成为 Macaca 贡献者。原文:https://macacajs.com/zh/contributing。
在 Macaca 开放一年之际,正式开放贡献计划,欢迎国内热情的工程师加入。
目前 Macaca 有大量的国内外用户和贡献者,而且仍将继续长期保持技术开放的形态,将技术 share 带给足下的国内社区。
一年前的开放计划:https://testerhome.com/topics/5001。
向 Macaca 项目的贡献者们致敬!
本篇文档写给正即将成为 contributor 的你。Macaca 起源于国内,长期保持技术开放的形态。整套方案涉及的语言栈很多,仅用户端就有 Java, Node.js, Python 等语言栈,工具层面也包括 C++, shell 等。开发平台涉及 Docker, iOS, Android, Chromium, x11 等多个开发平台,横跨 软件测试、计算机视觉、Node.js工具链、WEB及客户端技术 等多领域。
无论擅长哪一个技术领域,哪一种语言,都可以尝试加入 Macaca,贡献形式不限。
在新创建 issue 和在已有 issue 下评论,请尽量描述所遇到的问题和表达的意思,尽量避免反复确认信息,请在 FAQ 先确认问题是否已知。
如有文档遗漏或错误,欢迎补充,形式不限。
选择需要修改的仓库,Fork 到自己本地,如。
$ git clone git@github.com:macacajs/macaca-ios.git
$ cd macaca-ios
$ git remote add upstream git://github.com/macacajs/macaca-ios.git
请根据修改级别创建分支名如:features-xxx 或 bugfix-xxx
$ git checkout -b features-xxx -t origin/master
确认你的用户名和邮箱正确:
$ git config --global user.name "awesome"
$ git config --global user.email "awesome@macacajs.com"
向 github/macacajs 下的原仓库发起 pull request(PR),通过前提为当前仓库 CI 通过,github/macaca-sample 下的 sample 回归通过。
Macaca 是很多模块是集成在一起才能运行的,环境较单一功能的开源库要复杂很多。请参考具体核心模块仓库下的 CONTRIBUTING.md 了解如何调试,比如 UIAutomatorWD/CONTRIBUTING.md。
贡献者将会自动公示在项目主页,遵循 git-contributor 规则,如:
在任意模块有意义 PR 3 次以上,或解决重要问题的提交者,在征得提交者同意的情况下会邀请加入 Macaca Open Source Team。