mirror/gradio
2
0
Fork 0
mirror of https://github.com/gradio-app/gradio.git synced 2025-01-18 10:44:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Abubakar Abid 2021-12-16 10:25:09 -06:00 committed by GitHub
parent 8d5f55db18
commit d2f020d0df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -1,17 +1,26 @@
# Contributing to Gradio UI
# 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. All PRs must pass the continuous integration
tests and receive approval from a member of the Gradio UI development team before they will be merged.
tests and receive approval from a member of the Gradio development team before they will be merged.
### Structure of the Repository
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 source code for the actual Python library
* `/test`: contains unit tests for the Python library
* `/website`: contains the code for the Gradio website (www.gradio.app). See the README in the `/website` folder for more details
### Continuous Integration and Testing
All PRs must pass the continuous integration tests before merging. To test locally, you can run `python3 -m unittest`.
### 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
* A maintainer (@abidlabs, @aliabid94, @aliabd, or @dawoodkhan82) is tagged in the PR comments and asked to complete a review
* A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, or @dawoodkhan82) 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.