github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-18 04:49:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#10700)

Browse Source 
fiixed few typos
This commit is contained in:
Nino Risteski 2023-09-18 01:35:18 +02:00 committed by GitHub
parent 8371a8a0c6
commit d0070040da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/CONTRIBUTING.md vendored
View File

@ -9,7 +9,7 @@ to contributions, whether they be in the form of new features, improved infra, b
### 👩‍💻 Contributing Code ### 👩‍💻 Contributing Code
To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow. To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
Please do not try to push directly to this repo unless you are maintainer. Please do not try to push directly to this repo unless you are a maintainer.
Please follow the checked-in pull request template when opening pull requests. Note related issues and tag relevant Please follow the checked-in pull request template when opening pull requests. Note related issues and tag relevant
maintainers. maintainers.
@ -21,7 +21,7 @@ It's essential that we maintain great documentation and testing. If you:
- Fix a bug - Fix a bug
- Add a relevant unit or integration test when possible. These live in `tests/unit_tests` and `tests/integration_tests`. - Add a relevant unit or integration test when possible. These live in `tests/unit_tests` and `tests/integration_tests`.
- Make an improvement - Make an improvement
- Update any affected example notebooks and documentation. These lives in `docs`. - Update any affected example notebooks and documentation. These live in `docs`.
- Update unit and integration tests when relevant. - Update unit and integration tests when relevant.
- Add a feature - Add a feature
- Add a demo notebook in `docs/modules`. - Add a demo notebook in `docs/modules`.
@ -43,7 +43,7 @@ If you start working on an issue, please assign it to yourself.
If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature. If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature.
If two issues are related, or blocking, please link them rather than combining them. If two issues are related, or blocking, please link them rather than combining them.
We will try to keep these issues as up to date as possible, though We will try to keep these issues as up-to-date as possible, though
with the rapid rate of development in this field some may get out of date. with the rapid rate of development in this field some may get out of date.
If you notice this happening, please let us know. If you notice this happening, please let us know.
@ -174,7 +174,7 @@ Langchain relies heavily on optional dependencies to keep the Langchain package
If you're adding a new dependency to Langchain, assume that it will be an optional dependency, and If you're adding a new dependency to Langchain, assume that it will be an optional dependency, and
that most users won't have it installed. that most users won't have it installed.
Users that do not have the dependency installed should be able to **import** your code without Users who do not have the dependency installed should be able to **import** your code without
any side effects (no warnings, no errors, no exceptions). any side effects (no warnings, no errors, no exceptions).
To introduce the dependency to the pyproject.toml file correctly, please do the following: To introduce the dependency to the pyproject.toml file correctly, please do the following:
@ -188,7 +188,7 @@ To introduce the dependency to the pyproject.toml file correctly, please do the
```bash ```bash
poetry lock --no-update poetry lock --no-update
``` ```
4. Add a unit test that the very least attempts to import the new code. Ideally the unit 4. Add a unit test that the very least attempts to import the new code. Ideally, the unit
test makes use of lightweight fixtures to test the logic of the code. test makes use of lightweight fixtures to test the logic of the code.
5. Please use the `@pytest.mark.requires(package_name)` decorator for any tests that require the dependency. 5. Please use the `@pytest.mark.requires(package_name)` decorator for any tests that require the dependency.
@ -238,7 +238,7 @@ If you add support for a new external API, please add a new integration test.
### Adding a Jupyter Notebook ### Adding a Jupyter Notebook
If you are adding a Jupyter notebook example, you'll want to install the optional `dev` dependencies. If you are adding a Jupyter Notebook example, you'll want to install the optional `dev` dependencies.
To install dev dependencies: To install dev dependencies: