mirror of
https://github.com/hwchase17/langchain.git
synced 2026-02-21 06:33:41 +00:00
ae8db86486
Completed the sentence by adding a period ".", in sync with other points
>> Click "Propose changes"
to
>> Click "Propose changes".
Thank you for contributing to LangChain! Follow these steps to mark your
pull request as ready for review. **If any of these steps are not
completed, your PR will not be considered for review.**
- [ ] **PR title**: Follows the format: {TYPE}({SCOPE}): {DESCRIPTION}
- Examples:
- feat(core): add multi-tenant support
- fix(cli): resolve flag parsing error
- docs(openai): update API usage examples
- Allowed `{TYPE}` values:
- feat, fix, docs, style, refactor, perf, test, build, ci, chore,
revert, release
- Allowed `{SCOPE}` values (optional):
- core, cli, langchain, standard-tests, docs, anthropic, chroma,
deepseek, exa, fireworks, groq, huggingface, mistralai, nomic, ollama,
openai, perplexity, prompty, qdrant, xai
- Note: the `{DESCRIPTION}` must not start with an uppercase letter.
- Once you've written the title, please delete this checklist item; do
not include it in the PR.
- [ ] **PR message**: ***Delete this entire checklist*** and replace
with
- **Description:** a description of the change. Include a [closing
keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
if applicable to a relevant issue.
- **Issue:** the issue # it fixes, if applicable (e.g. Fixes #123)
- **Dependencies:** any dependencies required for this change
- **Twitter handle:** if your PR gets announced, and you'd like a
mention, we'll gladly shout you out!
- [ ] **Add tests and docs**: If you're adding a new integration, you
must include:
1. A test for the integration, preferably unit tests that do not rely on
network access,
2. An example notebook showing its use. It lives in
`docs/docs/integrations` directory.
- [ ] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. **We will not consider
a PR unless these three are passing in CI.** See [contribution
guidelines](https://python.langchain.com/docs/contributing/) for more.
Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to `pyproject.toml` files (even
optional ones) unless they are **required** for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
56 lines
2.6 KiB
Plaintext
56 lines
2.6 KiB
Plaintext
# Make your first docs PR
|
|
|
|
This tutorial will guide you through making a simple documentation edit, like correcting a typo.
|
|
|
|
### **Prerequisites**
|
|
- GitHub account.
|
|
- Familiarity with [GitHub pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (basic understanding).
|
|
|
|
---
|
|
|
|
## Editing a documentation page on GitHub
|
|
|
|
Sometimes you want to make a small change, like fixing a typo, and the easiest way to do this is to use GitHub's editor directly.
|
|
|
|
### **Steps**
|
|
|
|
1. **Navigate to the documentation page in the LangChain docs:**
|
|
- 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. **Fork the repository:**
|
|
- 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?](../reference/faq.mdx#how-do-i-allow-maintainers-to-edit-my-pr)).
|
|
- 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. **Make your changes:**
|
|
- Correct the typo directly in the GitHub editor.
|
|
|
|
4. **Commit your changes:**
|
|
- 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. **Submit a pull request (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.
|
|
|
|
## Getting a review
|
|
|
|
Once you've submitted the pull request, it will be reviewed by the maintainers. You may receive feedback or requests for changes. Keep an eye on the PR to address any comments.
|
|
|
|
Docs PRs are typically reviewed within a few days, but it may take longer depending on the complexity of the change and the availability of maintainers.
|
|
|
|
For more information on reviews, see the [Review Process](../reference/review_process.mdx).
|
|
|
|
## More information
|
|
|
|
See our [how-to guides](../how_to/documentation/index.mdx) for more information on contributing to documentation:
|