mirror/gradio
2
0
Fork 0
mirror of https://github.com/gradio-app/gradio.git synced 2025-03-01 11:45:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#2118)

Browse Source 
* Update CONTRIBUTING.md

* Update helpers.sh
This commit is contained in:
Abubakar Abid 2022-08-30 07:42:44 -07:00 committed by GitHub
parent 99833d506e
commit e5fd99c79b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -2,11 +2,10 @@
Prequisites: Prequisites:
* Python 3.7+ * [Python 3.7+](https://www.python.org/downloads/)
* Node 16.0+ (optional for backend-only changes, but needed for any frontend changes) * [pnpm version 7.x](https://pnpm.io/7.x/installation) (optional for backend-only changes, but needed for any frontend changes)
* pnpm version 6.x
More than 30 awesome developers have contributed to the `gradio` library, and we'd be thrilled if you would like be the next `gradio` contributor! You can start by forking or cloning the repo (https://github.com/gradio-app/gradio.git) and creating your own branch to work from. 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:
### Install Gradio locally from the `main` branch ### Install Gradio locally from the `main` branch
@ -24,38 +23,39 @@ bash scripts/build_frontend.sh
``` ```
### Install development and testing requirements ### Install testing requirements
* Navigate to the repo folder and install test requirements (note that it is highly recommended to use a virtual environment since the versions are pinned) In order to be able to run the Python 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)
``` ```
bash scripts/install_test_requirements.sh bash scripts/install_test_requirements.sh
``` ```
* It is recommended to use **Python 3.9** for development. If you have a different Python version and conflicting packages during the installation, you can run * If you have a different Python version and conflicting packages during the installation, please first run:
``` ```
bash scripts/create_test_requirements.sh bash scripts/create_test_requirements.sh
``` ```
```
bash scripts/install_test_requirements.sh ### Extra tidbits
```
* 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. * 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.
``` ```
gradio app.py gradio app.py
``` ```
* Run the tests
```
bash scripts/run_all_tests.sh
```
* You can also start a local frontend development server (on port 3000 by default) that responds to any changes in the frontend. * You can also start a local frontend development server (on port 3000 by default) that responds to any changes in the frontend.
``` ```
bash scripts/run_frontend.sh bash scripts/run_frontend.sh
``` ```
* To run all of the tests, do:
```
bash scripts/run_all_tests.sh
```
### Structure of the Repository ### Structure of the Repository
@ -79,7 +79,7 @@ All PRs must pass the continuous integration tests before merging. To test local
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: 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 * An initial review has been requested, and
* A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, @dawoodkhan82, @pngwn, @farukozderim) is tagged in the PR comments and asked to complete a review * A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, @dawoodkhan82, @pngwn, @freddyaboulton) 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. 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.

2
scripts/helpers.sh
View File

@ -48,7 +48,7 @@ function npm_required() {
# None # None
####################################### #######################################
function pnpm_required() { function pnpm_required() {
program_required "pnpm" "https://pnpm.io/6.x/installation" program_required "pnpm" "https://pnpm.io/7.x/installation"
} }
####################################### #######################################