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] How to contribute components #1838

Merged
merged 7 commits into from
May 9, 2024
Merged

Conversation

mendonk
Copy link
Collaborator

@mendonk mendonk commented May 6, 2024

Document how to contribute components to Langflow.

@mendonk mendonk requested a review from ogabrielluiz May 6, 2024 15:34
@mendonk mendonk self-assigned this May 6, 2024
Copy link

vercel bot commented May 6, 2024

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

Name Status Preview Comments Updated (UTC)
langflow ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2024 4:29pm

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 6, 2024
Copy link
Contributor

@ogabrielluiz ogabrielluiz left a comment

Choose a reason for hiding this comment

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

LGTM

docs/docs/contributing/contribute-component.md Outdated Show resolved Hide resolved
7. Add any new dependencies to the outer [pyproject.toml](https://github.com/langflow-ai/langflow/blob/dev/pyproject.toml#L27) file.
8. Submit your changes as a pull request. The Langflow team will have a look, suggest changes, and add your component to Langflow.


Copy link
Contributor

Choose a reason for hiding this comment

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

User Sharing

You might want to share and test your custom component with others. If so, you can:

  • Register at the Langflow store to share your component.
  • Undergo pre-validation before writing a pull request.
  • Easily deploy your amazing component directly to the Langflow store, without it being merged into the main source code.

Copy link
Contributor

Choose a reason for hiding this comment

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

Writing a pull request and waiting for review might be challenging for some. It would be beneficial to recommend using the Langflow store in this case. If there is documentation related to the Langflow store, it would be appropriate to provide a link to that document.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks @yamonkjd, this is good feedback. I added some info on submitting the store, wdyt?

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels May 8, 2024
@mendonk mendonk merged commit 561765c into dev May 9, 2024
5 checks passed
@mendonk mendonk deleted the docs-how-to-contribute-components branch May 28, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants