贡献给Single-spa
感谢你能关注single-spa! 我们非常愿意能够听到你的相关意见或者建议
我们已经将能够帮助你弄清流程的文档放在下面的指南中，希望能够对你有所帮助
目录
我们期望的贡献类型
你有多种方式来直接贡献给指南（降序排列）
- 例子
- 为缺失的框架添加示例库（像single-spa-react）
- 修复bug
- 在slack channel中回答问题
- 为框架添加帮助包
是否想做一些贡献？那就继续往下读吧！
相关规则 & 期望
在我们开始之前，下面的注意事项我们期望你能看一下
- 在讨论项目相关事情的时候可以有自己的想法，因为我们具有不同的背景和项目经验，所以我们有不同的视角来看待“开源应该如何来做”，你可以尝试一下多听取其他人而不是始终坚信自己的方式是对的
- 请通过阅读single-spa代码贡献指南来参与到本项目中，并同意遵守它的条款
- 在你提交PR之前，请确保你贡献的代码通过了所有测试，并且需要强调相关失败的测试用例，这样便于我们合并你贡献的代码
- 在你添加内容之前请先考虑是否它是有价值的。请不要添加参考链接到你或者你同事创建的页面中
如何进行贡献
如果你想参与贡献，请通过issues和pull requests来搜索是否有类似的问题或想法
如果你没有搜索到你的idea, 你可以考虑它适合作为本指南的一个目标，可以选择下面的一种方式来做
- 如果你贡献的PR是微小的, 例如是一个小的字体改动或者bug修复，请开一个PR
- 如果你贡献的PR是巨大的, 例如是一个新的feature, 请先开一个issue，这样在你开始做之前其他人能够在讨论区衡量他的重要性
搭建你自己的本地环境
前置条件
- Git
- Node: 下载 version 8.4 or greater
- Yarn: 查看 Yarn 站点安装说明
- fork single-spa 仓库
- clone当前仓库到你的本地
安装
cd single-spa渠道当前项目的根目录yarn安装single-spa的相关依赖
创建一个分支
- 从你的本地
single-spa仓库运行git checkout master git pull origin master确保你的本地有最新的代码git checkout -b the-name-of-my-branch(用一个合适的名字来替换the-name-of-my-branch) 来创建分支
测试更改点
- 从项目的根目录运行
yarn test
Push it
git add . && git commit -m "My message"(用commit信息来替换My message, 比如Fixed application lifecycles) 来stage和提交你的更改git push my-fork-name the-name-of-my-branch- 去到single-spa 仓库 这样能看到推送的分支.
- 遵循GitHub的说明来提交一个新的PR.
社区支持
请在single-spa 仓库的Issues 和 Pull Requests讨论single-spa的相关问题，任何人都是欢迎加入到讨论中的。这里也有slack community来做常规更新
如果可能的话，请不要直接私聊我们的维护人员(maintainers)。保持公开沟通便于每一个人都可以从对话中受益