Update CONTRIBUTING.md

This commit is contained in:
Abubakar Abid 2021-12-28 23:00:01 -06:00 committed by GitHub
parent 6d0c8c27bc
commit 70b7b4030d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,5 +1,5 @@
# Contributing to Gradio
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 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.
Next, to install the local development version of Gradio:
* Navigate to the `/gradio` subfolder and run `pip install -e .`.
@ -14,7 +14,7 @@ When installing locally, you may also need to build the front end:
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
* `/gradio`: contains the Python source code for the library
* `/gradio/interface.py`: contains the Python source code for the core `Interface` class
* `/gradio/interface.py`: contains the Python source code for the core `Interface` class (**start HERE!**)
* `/frontend`: contains the HTML/JS/CSS source code for the library
* `/test`: contains Python unit tests for the library
* `/demo`: contains demos that are used in the documentation as well as for integration tests
@ -22,10 +22,9 @@ It's helpful to know the overall structure of the repository so that you can foc
### Continuous Integration and Testing
All PRs must pass the continuous integration tests before merging. To test locally, you can run `python -m unittest` from the `/gradio` subfolder.
### Submitting PRs
All PRs must pass the continuous integration tests before merging. To test locally, you can run `python -m unittest` from `/` (the directory where you cloned this repo).
## Submitting PRs
All PRs should be against `master`. Direct commits to master are blocked, and PRs require an approving review
to merge into master. By convention, the Gradio maintainers will review PRs when:
* An initial review has been requested, and