跳到内容

贡献

我们非常欢迎您为 Instructor-rb 做出贡献。

从 Python 迁移文档

Python 版本中有很多示例，包括这里的文档 Python 文档

如果您想贡献，请查看 问题列表

问题

如果您发现错误，请在 我们的 GitHub 问题追踪器 上提交一个问题。

为了帮助我们重现错误，请提供一个最小的可重现示例，包括代码片段和完整的错误消息，以及

  1. 您使用的 response_model。
  2. 您使用的 messages。
  3. 您使用的 model。

环境设置

需要 Ruby 3.2.1 来运行项目。

安装

  1. 安装依赖项：运行以下命令安装项目依赖项
bundle install
  1. 环境变量：在您的环境变量中设置 OpenAI API 密钥。

代码质量工具

  • 本项目使用 rubocop。

运行测试

  • 使用以下命令执行测试
bundle exec rspec

运行 Rubocop

bundle exec rubocop

拉取请求

我们欢迎拉取请求！有很多事情可以做，我们很高兴讨论您想做出的任何贡献。

如果这不是一个小改动，请先 提交一个问题。

社区与支持

贡献者

附加资源

需要 Python 来使用 mkdocs 在本地运行文档。

为了提高您对文档的理解，这里有一些有用的参考资料

  • mkdocs serve: mkdocs serve 命令用于在开发阶段在本地预览您的文档。当您在终端中运行此命令时，MkDocs 会启动一个开发服务器，允许您在网络浏览器中查看和交互您的文档。这对于在发布文档之前检查您的更改外观非常有用。请参阅 mkdocs serve 文档 了解更多信息。

  • 代码块中的 hl_lines: 代码块中的 hl_lines 功能允许您突出显示代码块中的特定行。这对于在解释示例或提供说明时引起对特定代码行的注意非常有用。您可以使用代码块配置中的 hl_lines 选项指定要突出显示的行。有关更多详细信息和示例，请参阅 hl_lines 文档。

  • 警告框: 警告框是一种在文档中视觉上强调或引起注意某些信息的方式。它们有各种样式，例如注释、警告、提示等。警告框提供了一种结构化且一致的方式来呈现重要内容。有关使用示例和将警告框整合到文档中的详细信息，请参阅 警告框文档。

有关文档结构和功能的更多详细信息，请参阅 MkDocs Material 文档。

感谢您的贡献，编码愉快！