✨ 感谢你对 Flat 的贡献! ✨
遇到一些问题?不用担心,你可以通过旁边的的链接随时找到我们: 💬 加入 Slack 讨论组
作为 Flat 的用户,你是帮助我们改进文档的最佳人选。错别字的纠正,错误的修复,更好的解释,更多的例子,等等。对可以改进的事情创建 issues。任何东西都可以。甚至是对这个文件的改进。
有些问题是在信息缺失的情况下产生的,不能复现,或者纯粹是无效的。帮助它们让它们更容易解决。处理问题需要大量的时间,而我们可以把这些时间用于修复错误和增加功能。
我们一直在 issues 中寻找更多关于讨论的意见。这是一个影响 Flat 未来方向的好机会。
- issues 是为问题而设立的。
- 在提出一个问题之前,请先在 issues 中搜索之前是否讨论过。
- 确保你使用的 Flat 是的最新版本。
- 使用一个清晰和描述性的标题。
- 包括尽可能多的信息。复现问题的步骤,错误信息,客户端版本,操作系统,等等。
- 你在一个问题上投入的时间越多,我们就会投入越多。
- 最好的问题报告是一个失败的测试来证明它。
- 非微不足道的变化通常最好先在一个 issue 中讨论,以防止你做不必要的工作。
- 对于雄心勃勃的任务,你应该尽快让你的工作得到社区的反馈。一旦你完成了演示你想法中所需的最低要求,就打开一个拉请求在这个早期阶段,不要担心让事情变得完美,或者 100% 完成。在标题上加一个 [WIP] 的前缀,并描述你还需要做什么。这让审查员知道不要对小细节吹毛求疵,或者指出你已经知道你需要做的改进。
- 新功能应该有测试和文档。
- 不要包括不相关的修改。
- 在提交拉动请求之前,通过运行
$ pnpm lint
来进行代码检查 - 为拉取请求和提交的内容使用一个清晰的、描述性的标题。
- 写一个有说服力的描述,说明我们为什么要同意你的拉取请求。说服我们是你的工作。回答 "为什么" 需要它,并提供用例。
- 你可能会被要求对你的拉动请求进行修改。没有必要再开一个拉动请求。只需更新现有的那个。