为我们的文档做贡献
本篇文档网站托管在 公共 GitHub 仓库中。它使用 Next.js 构建，使用 MDX 编写，并部署在 Vercel 上。
我们的文档理念
我们的文档旨在
- 高效：我们不想浪费任何人的时间
- 易于理解：阅读这里的文本不应该要求英语母语水平或计算机科学学位
- 详尽：文档网站应包含任何人使用 Meilisearch 所需的所有信息
- 开源：这是 Meilisearch 用户为 Meilisearch 用户提供的资源
文档仓库和本地开发
Meilisearch 文档仓库仅存储文档网站的内容。由于构成该网站的代码位于另一个仓库中，因此无法运行文档的本地副本。
处理图像和其他静态资源
向 Meilisearch 文档贡献内容时，请将屏幕截图、图像、GIF 和视频存储在 /assets 下的相关目录中。
构建过程目前不支持使用相对路径的静态资源。将它们添加到文档时，请确保资源 URL 指向原始 GitHub 文件地址
\!\[Image description\]\(https://raw.githubusercontent.com/meilisearch/documentation/[branch_name]/assets/images/[guide_name]/diagram.png\)
如何贡献？
问题
Meilisearch 文档的维护者使用 GitHub Issues 来跟踪任务。有用的问题包括
- 通知文档团队有关不准确、过时或令人困惑的内容
- 请求新功能，例如版本控制或嵌入式控制台
- 请求新内容，例如新指南和教程
在打开问题或 PR 之前，请查看我们的 未解决的问题，看看是否存在针对您的问题的问题。 如果是，请留言告诉我们您正在等待修复或愿意自己解决。如果不是，请打开一个新问题，描述该问题并告知我们您是否要解决该问题。
我们喜欢 Meilisearch 的问题，因为它们有助于我们更好地完成工作。在十分之九的情况下，最有用的贡献是一个简单的 GitHub 问题，它指出了问题并提出了解决方案。
创建您的第一个问题
要打开问题，您需要一个 GitHub 帐户。如有必要，请创建一个，然后按照以下步骤操作
- 登录您的帐户
- 转到 Meilisearch 文档仓库
- 点击“问题”
- 使用搜索栏检查是否有人报告了相同的问题。如果有，请用 👍 投票，并且不要创建新问题！
- 如果没人报告您遇到的问题，请点击“新问题”
- 写一个简短且描述性的标题，然后添加更长的摘要来解释该问题。如果您报告的是错误，请确保包括重现该错误的步骤，以及您的操作系统和浏览器版本
- 点击“提交新问题”
- 我们团队的成员应该会 尽快回复您
- 享受出色完成工作的感觉！🎉
拉取请求
您还可以通过提出 拉取请求来改进文档。
拉取请求（简称“PR”）是请求将更改集成到 GitHub 仓库中。在我们的文档中创建 PR 的最简单方法是使用每个页面左下角的“编辑此页面”链接。
当您想执行以下操作时，拉取请求特别好
- 解决 现有问题
- 修复小错误，例如拼写错误或损坏的链接
- 创建或改进有关您非常了解的内容，例如有关如何将 Meilisearch 与您已掌握的工具集成的指南
在大多数情况下，最好在提出 PR 之前 创建一个问题。 这使您可以与文档维护者协调，并找到解决您想解决问题的最佳方法。
创建您的第一个 PR
要创建 PR，您需要一个 GitHub 帐户。如有必要，请创建一个，然后按照以下步骤操作
- 转到您想要编辑的文档页面，向下滚动，然后点击屏幕左下角的“编辑此页面”。这将带您进入 GitHub
- 如果您尚未登录，请立即登录。可能会提示您创建 fork
- 使用 GitHub 的文本编辑器更新页面
- 向下滚动，直到看到名为“建议更改”的框
- 填写第一个字段，为您的 PR 提供一个简短且描述性的标题，例如“修复搜索 API 参考中的拼写错误”
- 使用第二个字段来添加对您建议的更改的更详细的解释
- 点击“建议更改”按钮以继续。您应该看到一个页面显示“比较更改”
- 确保基本仓库设置为
meilisearch/documentation，并且基本分支设置为main。您可以忽略其余字段 - 此屏幕还将向您显示“差异”，它允许您查看您所做的更改与当前在文档网站上发布的内容的比较
- 点击“创建拉取请求”
- 恭喜，您提出了第一个 PR！文档维护者会尽快审查您的拉取请求。他们可能会要求更改，因此请密切关注您的 GitHub 通知
- 如果一切正常，您的工作将被合并到
main分支中，并成为官方文档站点的一部分。您现在是 Meilisearch 贡献者！🚀
我们如何审查贡献
我们如何审查问题
在审查问题时，我们会考虑以下几个标准
- 此任务是否是文档维护者的优先事项？
- 文档网站是否是此信息的最佳位置？有时，一个想法在我们的博客上可能比在文档中更好，或者链接到外部资源可能比我们自己编写和维护更有效
- 如果是错误报告，我们可以重现该错误吗？
如果用户通过投票或报告类似问题来表达对某个问题的兴趣，则文档更有可能将资源用于该任务。
我们如何审查 PR
对于审查贡献者的 PR，我们首先要确保 PR 符合我们的质量标准。
我们会提出以下问题
- 信息是否准确？
- 是否易于理解？
- 代码示例是否在没有错误的情况下运行？它们是否有助于用户理解我们正在解释的内容？
- 英语是否清晰简洁？非英语母语者能否理解？
- 语法是否完美？是否有拼写错误？
- 我们是否可以在不丢失任何重要信息的情况下缩短文本？
- 建议的更改是否需要更新文档网站中的其他页面？
- 在新内容的情况下，文章是否在正确的位置？文档中的其他文章是否应该链接到它？
没有什么比一个经过深思熟虑且有帮助的 PR 更让我们高兴的了。您的 PR 通常能为我们节省时间和精力，并使文档更加完善。
我们对 PR 贡献的唯一主要要求是，作者在合理的时间范围内回复沟通请求。
一旦您在此存储库中打开一个 PR，我们的团队成员会很快过来审查它。如果您的 PR 获得批准，您无需再做任何事情。但是，如果在七天内您没有回复进一步更改或更多信息的要求，我们将认为该 PR 已被放弃并关闭它。
如果这种情况发生在您身上，并且您认为存在一些错误，请告知我们，我们将尝试纠正这种情况。
为 Meilisearch 做贡献
有很多方法可以直接为 Meilisearch 做出贡献，例如
还有许多有价值的方法可以支持以上存储库
- 提供反馈
- 建议功能
- 创建测试
- 修复错误
- 添加内容
- 开发功能