FAutoTest/CONTRIBUTING.md

58 lines
2.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Contributing
欢迎任意形式的贡献。
## Acknowledgements
FAutoTest持续招聘贡献者即使是在Issues中回答问题或者在群里帮忙解答问题或者做一些简单的bugfix也会给FAutoTest带来很大的帮助。
FAutoTest已开发近半年在此感谢所有开发者对于FAutoTest的喜欢和支持希望你能够成为FAutoTest的核心贡献者加入FAutoTest共同打造一个更棒更好用的UI自动化测试框架🎉🎉🎉
## Issues
我们通过Github Issues来收集问题和功能相关的支持需求。
* Bug上报
如果FAutoTest不工作或者有异常排除环境问题后确认是FAutoTest本身问题并且在Issues中搜索未找到相关答案时欢迎提Issue讨论同时提问题的时的表述应当尽可能详细准确以确保您提出的问题是有效的。
* 新功能支持
如果你觉得FAutoTest存在不足的地方或者有更好的idea欢迎提Issue讨论。
* 问题探讨
如果你对FAutoTest存在疑问或者有一些不理解的地方欢迎提Issue或者进群讨论。
## Pull Requests
我们期待您通过PRPull Requests让FAutoTest变的更加完善。
### 分支管理
仓库一共包含两个分支:
1. `master` 分支
1. **请勿在master分支上提交任何PR。**
2. `dev` 分支
1. `dev`分支作为稳定的开发分支,经过测试后会在下一个版本合并到`master`分支。
2. **PR应该在`dev`分支上提交。**
### PR流程
FAutoTest团队会查看所有的PR我们会运行一些代码检查和测试一经测试通过我们会接受这次PR但不会立即将代码合并到master分支上会有一些延迟。
当您准备PR时请确保已经完成以下几个步骤:
1. 将仓库fork下来并且基于`dev`分支创建您的开发分支。
2. 如果您更改了APIs请更新代码及文档。
3. 在您添加的每一个新文件头部加上版权声明。
4. 检查您的代码语法及格式。
5. 反复测试。
6. 现在,您可以开始在`dev`分支上PR了。
## 许可证
通过为FAutoTest做出贡献代表您同意将其版权归为FAutoTest所有FAutoTest的开源协议为 [BSD-3-Clause License](LICENSE.txt)
## 贡献代码
如果你在使用过程中发现 Bug请通过 Issues 或 Pull Requests 来提交反馈,或者加入交流群来解决。
首次参与贡献请阅读:[CONTRIBUTING](CONTRIBUTING.md)
[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献,期待你的加入。