From 43b65b59ce18a5103698ac97a8aef385c1a097d3 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 4 Jun 2025 13:57:42 -0400 Subject: [PATCH] docs: contributing page links (#8316) * add-contributing-links * style * correct-url * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * link-names --------- Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> --- .../contributing-how-to-contribute.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/docs/Contributing/contributing-how-to-contribute.md b/docs/docs/Contributing/contributing-how-to-contribute.md index 8d0bdc9c4..7d265677a 100644 --- a/docs/docs/Contributing/contributing-how-to-contribute.md +++ b/docs/docs/Contributing/contributing-how-to-contribute.md @@ -22,9 +22,10 @@ Develop Langflow locally with [uv](https://docs.astral.sh/uv/getting-started/ins 1. Navigate to the [Langflow GitHub repository](https://github.com/langflow-ai/langflow), and then click **Fork**. 2. Add the new remote to your local repository on your local machine: - +Replace `YOUR_FORK_NAME` with a name for your fork. +Replace `YOUR_GIT_USERNAME` with your Git username. ```bash -git remote add fork https://github.com//langflow.git +git remote add YOUR_FORK_NAME https://github.com/YOUR_GIT_USERNAME/langflow.git ``` ### Prepare the development environment @@ -53,7 +54,6 @@ Use `launch.json` to quickly debug different parts of your application, like the ### Run Langflow locally After setting up the environment with `make init`, you can run Langflow's backend and frontend separately for development. -Langflow recommends using a virtual environment like [venv](https://docs.python.org/3/library/venv.html) or [conda](https://anaconda.org/anaconda/conda) to isolate dependencies. Before you begin, ensure you have [uv](https://docs.astral.sh/uv/getting-started/installation/) and [Node.js](https://nodejs.org/en/download/package-manager) installed. @@ -112,4 +112,11 @@ Some additional guidance on pull request titles: * Pull request titles appear in Langflow's release notes, so they should explain what the PR does as explicitly as possible. * Pull requests should strive to fix one thing **only**, and should contain a good description of what is being fixed. -For more information, see the [Python Developer's Guide](https://devguide.python.org/getting-started/pull-request-lifecycle/index.html#making-good-commits). \ No newline at end of file +For more information, see the [Python Developer's Guide](https://devguide.python.org/getting-started/pull-request-lifecycle/index.html#making-good-commits). + +## Additional contribution guides + +- [Contribute Bundles](./contributing-bundles.md) +- [Contribute Components](./contributing-components.md) +- [Contribute Tests](./contributing-component-tests.md) +- [Contribute Templates](./contributing-templates.md) \ No newline at end of file