Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#180)
Browse files Browse the repository at this point in the history
Add documentation step
  • Loading branch information
hsm207 authored May 12, 2024
1 parent bd2d2f5 commit 515df6e
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,17 @@ For minor changes, such as fixing typos in documentation or updating workflows a
1. Fork the repository.
2. Create a new branch from the `main` branch.
3. Make your changes.
4. Run the tests and linter. Make sure the tests pass.
5. Commit your changes.
6. Push your branch to your fork.
7. Create a PR.
8. In the PR, describe your changes and tag the issue e.g. (#123) that it fixes.
9. Label your PR with one of the following labels:
4. Update the getting started [notebook](https://github.com/langchain-ai/langchain/blob/master/docs/docs/integrations/vectorstores/weaviate.ipynb) if necessary
5. Run the tests and linter. Make sure the tests pass.
6. Commit your changes.
7. Push your branch to your fork.
8. Create a PR.
9. In the PR, describe your changes and tag the issue e.g. (#123) that it fixes.
10. Label your PR with one of the following labels:
- `bug`: If the PR fixes a bug.
- `documentation`: If the PR only changes the documentation.
- `enhancement`: If the PR adds new functionality.
- `quality-improvement`: If the PR is about enhancements to code or workflows for better quality, robustness, performance, etc.

Additionally, if the PR is a breaking change, add the `breaking` label.
10. Address review comments, if any.
11. Address review comments, if any.

0 comments on commit 515df6e

Please sign in to comment.