Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added a link to the taxonomy of labels in the contributing guide for easy access #28719

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bjoaquinc
Copy link
Contributor

Thank you for contributing to LangChain!

  • PR title: "package: description"

    • Where "package" is whichever of langchain, community, core, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes.
    • Example: "community: add foobar LLM"
  • PR message: Delete this entire checklist and replace with

    • Description: Added a link to make it easier to organize github issues for langchain.
    • Issue: After reading that there was a taxonomy of labels I had to figure out how to find it.
    • Dependencies: None
    • Twitter handle: None
  • Add tests and docs: If you're adding a new integration, please 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. See contribution guidelines for more: https://python.langchain.com/docs/contributing/

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.
  • If you are adding something to community, do not re-import it in langchain.

If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.

Copy link

vercel bot commented Dec 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langchain ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 14, 2024 2:33am

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Dec 14, 2024
Copy link
Member

@efriis efriis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chatting with the team on what is most useful here. I think listing a few specific ones is probably more useful than the exhaustive list!

@efriis efriis self-assigned this Dec 15, 2024
@bjoaquinc
Copy link
Contributor Author

bjoaquinc commented Dec 16, 2024

chatting with the team on what is most useful here. I think listing a few specific ones is probably more useful than the exhaustive list!

Yeah I think this is a great idea! Navigating issues has been very confusing and It would make understanding and filtering issues a lot easier for prospective contributors like myself.

Want me to create an label-taxonomy.mdx file here after you and the team decide on which specific tags to highlight?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants