提交你的第一个文档PR

本教程将指导您完成一个简单的文档编辑，例如纠正拼写错误。

先决条件​

• GitHub 账户。
• 熟悉GitHub拉取请求（基本理解）。

---

在GitHub上编辑文档页面​

有时你想做一些小的改动，比如修正一个拼写错误，最简单的方法是直接使用GitHub的编辑器。

步骤​

1. 导航到LangChain文档中的文档页面：

   • On the documentation page, find the green "Edit this page" link at the bottom of the page.
   • Click the button to be directed to the GitHub editor.
   • If the file you're editing is a Jupyter Notebook (.ipynb) instead of a Markdown (.md, .mdx) file, we recommend following the steps in section 3.

2. 复制仓库：

   • If you haven't already, GitHub will prompt you to fork the repository to your account.
   • Make sure to fork the repository into your personal account and not an organization (why?).
   • Click the "Fork this repository" button to create a copy of the repository under your account.
   • After forking, you'll automatically be redirected to the correct editor.

3. 进行更改：

   • Correct the typo directly in the GitHub editor.

4. 提交您的更改：

   • Click the "Commit changes..." button at the top-right corner of the page.
   • Give your commit a title like "Fix typo in X section."
   • Optionally, write an extended commit description.
   • Click "Propose changes"

5. 提交一个拉取请求（PR）：

   • GitHub will redirect you to a page where you can create a pull request.
   • First, review your proposed changes to ensure they are correct.
   • Click Create pull request.
   • Give your PR a title like docs: Fix typo in X section.
   • Follow the checklist in the PR description template.

获取评论​

一旦你提交了拉取请求，它将会被维护者审查。你可能会收到反馈或修改请求。请密切关注PR以处理任何评论。

文档的PR通常会在几天内被审查，但根据变更的复杂性和维护者的可用性，可能需要更长的时间。

有关评审的更多信息，请参阅评审流程。