HOW_TO_CONTRIBUTE.md

June 23, 2023 · View on GitHub

欢迎来到 聚宝盆(Cornucopia)项目！ 感谢您有兴趣为我们的项目做出贡献。为了使投稿过程尽可能顺利，我们制定了一些指南来帮助您提交贡献投稿。 在您开始贡献之前，请花几分钟时间查看以下指南。

如何贡献代码

  1. Fork 项目并将其 clone 到本地。
  2. 使用描述性名称为您的贡献创建一个新分支。
  3. 进行更改并确保它们经过适当的测试。
  4. 向我们存储库的主分支提交 pull request。

如何贡献代码

如果您正在贡献prompts 或 prompt seeds，请使用以下标题格式打开一个新 issue：[New Prompt]: 或 [New Prompt Seed]:。

如果您正在贡献新的数据集：

  1. 请核实我们官方数据集的格式。
  2. 将您的数据集上传到某处，例如 HuggingFace。
  3. 新建一个 issue 标题为：[Contributing Data]:。 描述数据集，例如 规模、内容等
  4. 在 issue 中包含指向您的数据集的链接。

贡献指南

请确保您的贡献符合以下准则：

  1. 遵循项目中使用的编码风格和约定。
  2. 确保您的贡献有据可查且易于理解
  3. 保持您的贡献简洁明了。 如果您正在进行多项更改，请考虑将它们分成单独的拉取请求。
  4. 不要提交包含专有或机密信息的文稿。

提交 Issues

如果您在使用我们的项目时遇到任何问题，请通过我们的 issue 跟踪器报告。 请提供尽可能多的有关该问题的信息，包括重现该问题的步骤。

在提交问题之前，请先搜索现有问题 :)

结论

感谢您花时间阅读这些指南。 我们感谢您的贡献，并期待与您合作！ 如果您有任何问题或疑虑，请联系项目维护人员。