Skip to content

Commit

Permalink
docs: Update integration contributing instructions (#6939)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacoblee93 authored Oct 4, 2024
1 parent 660af3e commit eb9ce8d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ You can invoke the script by calling `yarn release`. If new dependencies have be

There are three parameters which can be passed to this script, one required and two optional.

- __Required__: `<workspace name>`. eg: `@langchain/core` The name of the package to release. Can be found in the `name` value of the package's `package.json`
- __Optional__: `--bump-deps` eg `--bump-deps` Will find all packages in the repo which depend on this workspace and checkout a new branch, update the dep version, run yarn install, commit & push to new branch. Generally, this is not necessary.
- __Optional__: `--tag <tag>` eg `--tag beta` Add a tag to the NPM release. Useful if you want to push a release candidate.
- **Required**: `<workspace name>`. eg: `@langchain/core` The name of the package to release. Can be found in the `name` value of the package's `package.json`
- **Optional**: `--bump-deps` eg `--bump-deps` Will find all packages in the repo which depend on this workspace and checkout a new branch, update the dep version, run yarn install, commit & push to new branch. Generally, this is not necessary.
- **Optional**: `--tag <tag>` eg `--tag beta` Add a tag to the NPM release. Useful if you want to push a release candidate.

This script automatically bumps the package version, creates a new release branch with the changes, pushes the branch to GitHub, uses `release-it` to automatically release to NPM, and more depending on the flags passed.

Expand Down Expand Up @@ -323,6 +323,10 @@ Similar to linting, we recognize documentation can be annoying. If you do not wa

Documentation and the skeleton lives under the `docs/` folder. Example code is imported from under the `examples/` folder.

**If you are contributing an integration, please copy and use the appropriate template from here:**

https://github.com/langchain-ai/langchainjs/tree/main/libs/langchain-scripts/src/cli/docs/templates

### Running examples

If you add a new major piece of functionality, it is helpful to add an
Expand Down
8 changes: 6 additions & 2 deletions docs/core_docs/docs/contributing/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,12 @@ For information on running and implementing tests, see the [Testing guide](/docs
### Write documentation
Documentation is generated from Jupyter notebooks or `.mdx` files in the `docs/` directory. You should place the notebooks with examples
to the relevant `docs/core_docs/docs/integrations` directory in the monorepo root.
Please copy and use the appropriate template from here:
https://github.com/langchain-ai/langchainjs/tree/main/libs/langchain-scripts/src/cli/docs/templates
You should place the notebooks with examples
in the relevant `docs/core_docs/docs/integrations` directory in the monorepo root.
### (If Necessary) Deprecate community integration
Expand Down

0 comments on commit eb9ce8d

Please sign in to comment.