Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#5799)
Browse files Browse the repository at this point in the history 
* updates

* tweak

* tweaks

* tweaks

* add troubleshooting

* storybook tweak

* add review changes

* fe tweak
  • Loading branch information
@hannahblair
hannahblair committed Oct 5, 2023
1 parent e4a307e commit 59c3591
Showing 1 changed file with 148 additions and 46 deletions.
194 changes: 148 additions & 46 deletions CONTRIBUTING.md
View file
@@ -1,17 +1,24 @@
# Contributing to Gradio

![GitHub issues by-label](https://img.shields.io/github/issues/gradio-app/gradio/good%20first%20issue?color=fe7c01&link=https%3A%2F%2Fgithub.com%2Fgradio-app%2Fgradio%2Fissues%3Fq%3Dis%253Aopen%2Bis%253Aissue%2Blabel%253A%2522good%2Bfirst%2Bissue%2522)


More than 200 awesome developers have contributed to the `gradio` library, and we'd be thrilled if you would like to be the next contributor!

Prerequisites:

- [Python 3.8+](https://www.python.org/downloads/)
- [Node.js v16.14+](https://nodejs.dev/en/download/package-manager/) (only needed if you are making changes to the frontend)
- [pnpm 8.1+](https://pnpm.io/8.x/installation) (only needed if you are making changes to the frontend)

## 🏡 Setup for local development

More than 80 awesome developers have contributed to the `gradio` library, and we'd be thrilled if you would like be the next `gradio` contributor! Start by cloning this repo and installing Gradio locally:
There are a few ways to install and run Gradio.

### Install Gradio locally from the `main` branch
### 🛠️ Install Gradio locally from `main`

- Clone this repo
- Navigate to the repo folder and run
- Navigate to the repo directory and (from the root directory) run

```bash
bash scripts/install_gradio.sh
Expand All @@ -23,25 +30,23 @@ bash scripts/install_gradio.sh
bash scripts/build_frontend.sh
```

### Install development requirements
- Install development requirements

In order to be able to run the Python linter, formatter, and unit tests, do the following:

- Navigate to the repo folder and install test requirements (note that it is highly recommended to use a virtual environment running **Python 3.9** since the versions are pinned)
(Note that it is highly recommended to use a virtual environment running **Python 3.9** since the versions of Gradio's dependencies are pinned)

```
bash scripts/install_test_requirements.sh
```

- If you have a different Python version and conflicting packages during the installation, please first run:
If you have a different Python version and conflicting packages during the installation, please first run:

```
bash scripts/create_test_requirements.sh
```

### Using dev containers
### 📦 Using dev containers

Instead of the above steps, you can alternatively use dev containers. This is supported on all platforms (macOS/Windows/Linux).
You can alternatively use dev containers. This is supported on all platforms (macOS/Windows/Linux), as well as on GitHub Codespaces.

Prerequisites:

Expand All @@ -55,55 +60,142 @@ Prerequisites:
Steps:

- Clone repository
- Open it in editor
- Open it in your editor
- For VS Code, execute `Dev Containers: Reopen in container` command

For detailed instructions, please see the [Dev Containers tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial).

### Extra tidbits
## 🧱 Structure of the Repository

If you're a newcomer to Gradio, we recommend getting familiar with the overall structure of the repository so that you can focus on the part of the source code you'd like to contribute to.

- `/gradio`: contains the Python source code for the library
- `/gradio/interface.py`: contains the Python source code for the core `Interface` class
- `/gradio/blocks.py`: contains the Python source code for the core `Blocks` class
- `/gradio/components/`: the directory that contains the Python source code for all of the Gradio components.
- `/js`: contains the HTML/JS/CSS source code for the library ([start here for frontend changes](/js/README.md))
- `/test`: contains Python unit tests for the library
- `/demo`: contains demos that are used in the documentation, you can find `Gradio` examples over here.
- `/website`: contains the code for the Gradio website (www.gradio.app). See the README in the `/website` folder for more details


## 🚀 Run a Gradio app

You can get started by creating an `app.py` file in the root:

```
import gradio as gr
with gr.Blocks() as demo:
gr.Button()
if __name__ == "__main__":
demo.launch()
```

- You can run gradio scripts in reload mode which will watch for changes in the `gradio` folder and reload the app if changes are made.
then run:

```
gradio app.py
```

- To develop the frontend app, you should also follow [js/README.md](js/README.md).
This will start the backend server in reload mode, which will watch for changes in the `gradio` folder and reload the app if changes are made. By default, Gradio will launch on port 7860. You can also just use `python app.py`, but this won't automatically trigger updates.

- To run all of the tests, do:

If you're making frontend changes, start the frontend server:

```
pnpm dev
```
This will open a separate browser tab. By default, Gradio will launch this on port 9876. Any changes to the frontend will also reload automatically in the browser. For more information about developing in the frontend, you can refer to [js/README.md](js/README.md).

We also have demos of all our components in the `/gradio/demo` directory. To get our simple gradio Chatbot running locally:

```
gradio demo/chatbot_simple/run.py
```


## 🧪 Testing

We use Pytest, Playwright and Vitest to test our code.

- The Python tests are located in `/test`. To run these tests:

```
bash scripts/run_all_tests.sh
```

### Structure of the Repository
- The frontend unit tests are any defined with the filename `*.test.ts`. To run them:

It's helpful to know the overall structure of the repository so that you can focus on the part of the source code you'd like to contribute to
```
pnpm test
```

- `/gradio`: contains the Python source code for the library
- `/gradio/interface.py`: contains the Python source code for the core `Interface` class
- `/gradio/blocks.py`: contains the Python source code for the core `Blocks` class
- `/gradio/components.py`: contains the Python source code for the `components`, you can add your custom components here.
- `/js`: contains the HTML/JS/CSS source code for the library ([start here for frontend changes](/js/README.md))
- `/test`: contains Python unit tests for the library
- `/demo`: contains demos that are used in the documentation, you can find `Gradio` examples over here.
- `/website`: contains the code for the Gradio website (www.gradio.app). See the README in the `/website` folder for more details
- Browser tests are located in `js/app/test` and are defined as `*spec.ts` files. To run browser tests:

```
pnpm test:browser
```

To build the frontend code before running browser tests:

```
pnpm test:browser:full
```

You can also run browser tests in the UI mode by adding the `--ui` flag:

```
pnpm test:browser --ui
```

If you have made any significant visual changes to a component, we encourage you to add a new Storybook story or amend an existing one to reflect them. You can create a new story with a `*.stories.svelte` file.

## 🕸️ Gradio Website

We also welcome any contributions to our [website](https://www.gradio.app).

First, build the website:

```
pnpm build:cdn-local
```
then serve the website build:
```
pnpm preview:cdn-local
```

This will serve a build of `gradio.js` on port `4321`. You can then navigate to `js/_website/src/routes/+layout.svelte` and replace the source of the website build from:
```
<script type="module" src="https://gradio.s3-us-west-2.amazonaws.com/{version}/gradio.js"></script>
```
to
```
<script type="module" src="http://localhost:4321/gradio.js"></script>
```

### Continuous Integration and Testing
You should now be able to view a local version of the website at `http://localhost:4321`.
## 📚 Component Storybook

All PRs must pass the continuous integration tests before merging. To test locally, you can run `python -m unittest` from the repo directory.
If you would like to fix an issue or contribute to our Storybook, you can get it running locally with:

## Submitting PRs
```
pnpm storybook
```

All PRs should be against `main`. Direct commits to main are blocked, and PRs require an approving review to merge into main. By convention, the Gradio maintainers will review PRs when:

- An initial review has been requested, and
- A description of the change (with a link to the GitHub PR) has been added to CHANGELOG.md, and
- A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, @dawoodkhan82, @pngwn, @freddyaboulton) is tagged in the PR comments and asked to complete a review
## 📮 Submitting PRs

We ask that you make sure initial CI checks are passing before requesting a review. One of the Gradio maintainers will merge the PR when all the checks are passing.
All PRs should be against `main`, and ideally should address an open issue, unless the change is small. Direct commits to main are blocked, and PRs require an approving review to merge into main. By convention, the Gradio maintainers will review PRs when:

Do not forget the format the backend before pushing.
- An initial review has been requested
- A clear, descriptive title has been assigned to the PR
- A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, @dawoodkhan82, @pngwn, @freddyaboulton, @hannahblair) is tagged in the PR comments and asked to complete a review

🧹 We ask that you make sure initial CI checks are passing before requesting a review. One of the Gradio maintainers will merge the PR when all the checks are passing. You can safely ignore the Vercel and Spaces checks, which only run under maintainers' pull requests.

Don't forget the format your code before pushing:

```
bash scripts/format_backend.sh
Expand All @@ -113,26 +205,36 @@ bash scripts/format_backend.sh
bash scripts/format_frontend.sh
```

## CI checks
Thank you for taking the time to contribute to our project!
## ❓ Need help getting started?

- Browse [issues](https://github.com/gradio-app/gradio/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) with the "good first issue" label. These are issues we think are good for newcomers.
- Ask the Gradio community in our [Discord](https://discord.com/invite/feTf9x3ZSB)
- Raise an issue for a feature or a bug you want to tackle

## 🚧 Troubleshooting
`ERROR: Error loading ASGI app. Could not import module "<filename>"`

Verify that you've used the correct filename of your gradio app, and that you're in the directory of the file.

Currently the following checks are run in CI:
---

### Gradio library (`gradio` package)
```ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL @gradio/app@1.0.0 build:local: vite build --mode production:local --emptyOutDir "--emptyOutDir"```

Delete `/node_modules` and `pnpm-lock.yaml`:

```
bash scripts/lint_backend.sh
bash scripts/type_check_backend.sh
python -m pytest -m "not flaky" --ignore=client
python -m pytest -m "flaky" --ignore=client
rm -rf node_modules/
rm pnpm-lock.yaml
```

### Gradio client (`gradio_client` package)
and run the install scripts:

```
cd client/python
bash scripts/lint.sh
python -m pytest -m "not flaky"
python -m pytest -m "flaky"
bash scripts/install_gradio.sh
bash scripts/build_frontend.sh
```
---

_Could these guidelines be clearer? Feel free to open a PR to help us faciltiate open-source contributions!_

0 comments on commit 59c3591

Please sign in to comment.