为Seata贡献
如果您有兴趣攻克Seata,欢迎您。首先,我们非常鼓励这种意愿。这是为您提供帮助的列表。
话题
报告安全问题
安全问题应该始终得到认真对待。按照我们通常的原则,我们不鼓励任何人散布安全问题。如果您发现Seata的安全问题,请不要公开讨论,甚至不要公开问题。相反,我们建议您向我们发送一封私人电子邮件至 private@seata.apache.org进行举报。
报告一般问题
坦白地说,我们认为Seata的每位用户都是非常友好的贡献者。体验Seata之后,您可能会对项目有一些反馈。然后随时通过NEW ISSUE打开问题。
因为我们在一个分布式的方式合作项目Seata,我们对此表示赞赏编写良好,详细,明确的问题报告。为了提高沟通效率,我们希望每个人都可以搜索您的问题是否在搜索列表中。如果发现它存在,请在现有问题下的评论中添加您的详细信息,而不要打开一个全新的issue。
为了使问题详细信息尽可能地标准,我们为问题报告者设置了“ 问题模板 ”。请务必按照说明填写模板中的字段。
在很多情况下,您可以打开一个问题:
- 错误报告
- 功能要求
- 性能问题
- 功能提案
- 功能设计
- 需要帮助
- doc不完整
- 测试改进
- 有关项目的任何问题
- 等等
另外,我们必须提醒您,在填写新issue时,请记住从您的帖子中删除敏感数据。敏感数据可以是密码,密钥,网络位置,私人业务数据等。
代码和文档贡献
鼓励 采取一切措施使Seata项目变得更好。在GitHub上,Seata的每个改进都可以通过PR(拉取请求的缩写)来实现。
- 如果发现错字,请尝试解决!
- 如果发现错误,请尝试修复它!
- 如果发现一些冗余代码,请尝试将其删除!
- 如果发现缺少一些测试用例,请尝试添加它们!
- 如果您可以增强功能,请不要犹豫!
- 如果发现隐式代码,请尝试添加注释以使其清晰!
- 如果您发现代码丑陋,请尝试重构它!
- 如果可以帮助改善文档,那就再好不过了!
- 如果发现文档不正确,请直接解决该问题!
- ...
实际上,不可能完全列出它们。只要记住一个原则:
我们期待您的任何回复。
由于您已准备好通过PR改善Seata,因此建议您在此处查看PR规则。
工作准备
要提出PR,我们假设您已经注册了GitHub ID。然后,您可以按照以下步骤完成准备工作:
-
FORK Seata分支到您的 存储库。要使此工作有效,您只需要单击apache/incubator-seata主页右边的按钮Fork 。然后,您将在
https://github.com/<your-username>/incubator-seata
中your-username
找到您的存储库,这是您的GitHub用户名。 -
CLONE您自己的存储库以在本地进行开发。用于
git clone git@github.com:<your-username>/seata.git
将存储库克隆到本地计算机。然后,您可以创建新分支来完成您希望进行的更改。 -
Set Remote上游设置为
git@github.com:apache/incubator-seata.git
使用以下两个命令:
git remote add upstream git@github.com:apache/incubator-seata.git
git remote set-url --push upstream no-pushing
使用此远程设置,您可以像这样检查git远程配置:
$ git remote -v
origin git@github.com:<your-username>/seata.git (fetch)
origin git@github.com:<your-username>/seata.git (push)
upstream git@github.com:apache/incubator-seata.git (fetch)
upstream no-pushing (push)
加上这一点,我们可以很容易地将本地分支与上游分支同步。