# 如何参与共建?
一个开源项目的成功离不开社区伙伴的支持。作为 Soft Storage 的作者,我由衷地希望社区中的开发者们能够参与到项目的共建中来。所以,为了可以更高效地为 Soft Storage 做出贡献,请耐心阅读本章节的内容,相信它一定能够对你有所帮助。
# 创建 issue
我们欢迎每一个有价值的 issue,包括但不限于:
- 您所遇到的 bug
- 关于新功能的好点子
- 源代码中不好的写法
- ……
但是,为了保证较高的效率,请在提出 issue 时遵循以下原则:
- 确保您已经完整阅读过项目文档,且文档中并未给出相关问题的解决方案
- 确保您的 issue 不是已知的 issue
- 如果是遇到了一个 bug,请尽可能地在沙盒环境中提供一个最小化的 demo
- 如果是一个好点子,请尽可能地给出相关的伪代码,并辅以说明
# 提交 Pull Request
您可以对我们的源代码做出变更,包括但不限于:
- 修复一个 bug
- 添加新特性
- ……
为了能够快速上手项目的开发,您可以参考我们的开发者指南。