jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: reduce duplicate content in contributing.md (#9136)

Browse source 
reduce-duplicate-setup-content
This commit is contained in:
Mendon Kissling 2025-07-23 10:17:29 -04:00 • committed by GitHub
commit b519057df7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

163
CONTRIBUTING.md
View file

@ -1,163 +1,30 @@
# Contributing to Langflow
# How to contribute to Langflow
This guide is intended to help you start contributing to Langflow.
As an open-source project in a rapidly developing field, Langflow welcomes contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
Thank you for your interest in contributing!
To contribute code or documentation to this project, follow the [fork and pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
## Install Langflow from source
Install Langflow from source by forking the repository, and then set up your development environment using Make.
### Prerequisites
* [uv](https://docs.astral.sh/uv/getting-started/installation/) version 0.4 or later
* [Node.js](https://nodejs.org/en/download/package-manager)
* [Make](https://www.gnu.org/software/make/#documentation)
### Clone the Langflow repository
## How to Contribute
1. Fork the [Langflow GitHub repository](https://github.com/langflow-ai/langflow).
2. Create a new branch for your changes.
3. Submit a pull request to the `main` branch with a clear title and description.
Reference any issues fixed, for example `Fixes #1234`.
Ensure your PR title follows [semantic commit conventions](https://www.conventionalcommits.org/).
4. A maintainer will review your PR and may request changes.
2. Add the new remote to your local repository on your local machine:
```bash
git remote add FORK_NAME https://github.com/GIT_USERNAME/langflow.git
```
Replace the following:
* `FORK_NAME`: A name for your fork of the repository
* `GIT_USERNAME`: Your Git username
## Development Environment Setup
### Run Langflow from source
For detailed instructions on setting up your local development environment, see [DEVELOPMENT.md](./DEVELOPMENT.md).
If you're not developing, but want to run Langflow from source after cloning the repo, run:
## Documentation Contributions
```bash
make run_cli
```
Langflow documentation is built with [Docusaurus](https://docusaurus.io/).
For setup instructions, see [DEVELOPMENT.md](./DEVELOPMENT.md).
This command:
- Installs frontend and backend dependencies
- Builds the frontend static files
- Starts the application with default settings
The `make run_cli` command allows you to configure the application such as logging level, host, port, and environment variables.
For example, this command starts Langflow with custom settings for the logging level, host binding, and port number, and specifies a custom `.env` file.
```bash
make run_cli log_level=info host=localhost port=8000 env=.env.custom
```
The `make run_cli` command accepts the following parameters:
| Parameter | Default | Description |
|-----------|---------|-------------|
| `log_level` | `debug` | Set the logging level. Options: `debug`, `info`, `warning`, `error`, `critical` |
| `host` | `0.0.0.0` | The host address to bind the server to. Use `localhost` or `127.0.0.1` for local-only access. |
| `port` | `7860` | The port number to run the server on. |
| `env` | `.env` | Path to the environment file containing configuration variables. |
| `open_browser` | `true` | Whether to automatically open the browser when starting. Set to `false` to disable. |
### Set up your Langflow development environment
1. To set up the Langflow development environment, run the following command:
```bash
make init
```
This command sets up the development environment by:
- Checking for uv and npm.
- Installing backend and frontend dependencies.
- Installing pre-commit hooks.
2. Run the backend and frontend in separate terminals for development:
```bash
# Run backend in development mode (includes hot reload)
make backend
# In another terminal, run frontend in development mode (includes hot reload)
make frontend
```
The `make backend` and `make frontend` commands automatically install dependencies, so you don't need to run install commands separately.
3. (Optional) Install pre-commit hooks to help keep your changes clean and well-formatted. `make init` installs pre-commit hooks automatically.
```bash
uv sync
uv run pre-commit install
```
:::note
With pre-commit hooks installed, you need to use `uv run git commit` instead of `git commit` directly.
:::
4. To test your changes, run `make lint`, `make format`, and `make unit_tests` before pushing to the repository.
To run all tests, including unit tests, integration tests, and coverage, run `make tests`.
### Debug
The repo includes a `.vscode/launch.json` file for debugging the backend in VSCode, which is faster than debugging with Docker Compose. To debug Langflow with the `launch.json` file in VSCode:
For more information, see the [VSCode documentation](https://code.visualstudio.com/docs/debugtest/debugging#_start-a-debugging-session).
### Additional contribution guides
## Additional Guides
- [Contribute Bundles](./docs/docs/Contributing/contributing-bundles.md)
- [Contribute Components](./docs/docs/Contributing/contributing-components.md)
- [Contribute Tests](./docs/docs/Contributing/contributing-component-tests.md)
- [Contribute Templates](./docs/docs/Contributing/contributing-templates.md)
## Contribute documentation
The documentation is built using [Docusaurus](https://docusaurus.io/) and written in [Markdown](https://docusaurus.io/docs/markdown-features).
Contributions should follow the [Google Developer Documentation Style Guide](https://developers.google.com/style).
### Prerequisites
* [Node.js](https://nodejs.org/en/download/package-manager)
* [Yarn](https://yarnpkg.com/)
### Clone the Langflow repository
1. Fork the [Langflow GitHub repository](https://github.com/langflow-ai/langflow).
2. Add the new remote to your local repository on your local machine:
```bash
git remote add FORK_NAME https://github.com/GIT_USERNAME/langflow.git
```
Replace the following:
* `FORK_NAME`: A name for your fork of the repository
* `GIT_USERNAME`: Your Git username
3. From your Langflow fork's root, change directory to the `langflow/docs` folder with the following command:
```bash
cd docs
```
4. To install dependencies and start a local Docusaurus static site with hot reloading, run:
```bash
yarn install && yarn start
```
The documentation will be available at `localhost:3000` and all the files are located in the `/docs` folder.
5. Optional: Run `yarn build` to build the site locally and ensure there are no broken links.
## Open a pull request
To submit a pull request, do the following:
1. Open a new GitHub pull request with your patch against the `main` branch.
2. Ensure the PR title follows semantic commit conventions. For example, features are `feat: add new feature` and fixes are `fix: correct issue with X`.
Some additional guidance on pull request titles:
* Ensure the pull request description clearly describes the problem and solution. If the PR fixes an issue, include a link to the fixed issue in the PR description with `Fixes #1234`.
* 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.
3. A Langflow maintainer will review your pull request and may request changes, so ensure you pay attention to your PRs. Thanks for your contribution!
For more information, see the [Python Developer's Guide](https://devguide.python.org/getting-started/pull-request-lifecycle/index.html#making-good-commits).
Thank you for helping improve Langflow!

10
DEVELOPMENT.md
View file

@ -162,9 +162,9 @@ At this point, you can navigate to http://localhost:3000/ in a browser and acces
### Build and Display Documentation
If you are contributing changes to documentation (always welcome!), these are built (using [Docusaurus](https://docusaurus.io/)) and served separately, also using Node.js.
If you are contributing changes to documentation (always welcome!), these are built using [Docusaurus](https://docusaurus.io/) and served separately, also using Node.js.
In the *Documentation Terminal* (from the project root directory), run the following:
In the terminal, from the project root directory, run the following:
```bash
cd docs
@ -182,11 +182,11 @@ At which point you can navigate to http://localhost:3001/ in a browser and view
## Adding or Modifying a Component
Components reside in folders under `src/backend/base/langflow`, and their unit tests under `src/backend/base/tests/unit/components`.
Components reside in folders under `src/backend/base/langflow`, and their unit tests under `src/backend/base/tests/unit/components`.
### Adding a Component
Add the component to the appropriate subdirectory, and add the component to the `__init__.py` file (alphabetical ordering on the `import` and the `__all__` list). Assuming the backend and frontend services are running, the backend service will restart as these files are changed. The new component will be visible after the backend is restarted, _*and*_ after you hit "refresh" in the browser.
Add the component to the appropriate subdirectory, and add the component to the `__init__.py` file (alphabetical ordering on the `import` and the `__all__` list). Assuming the backend and frontend services are running, the backend service will restart as these files are changed. The new component will be visible after the backend is restarted, _*and*_ after you hit "refresh" in the browser.
> [!TIP]
> It is faster to copy-paste the component code from your editor into the UI *without* saving in the source code in the editor, and once you are satisfied it is working you can save (restarting the backend) and refresh the browser to confirm it is present.
@ -221,7 +221,7 @@ Once you are happy your changes are complete, commit them and push the changes t
## Some Quirks!
You may observe some quirky things:
You may observe some quirky things:
### Testing