mirror of
https://github.com/gradio-app/gradio.git
synced 2024-11-21 01:01:05 +08:00
test-guideline (#990)
* test-guideline - add backend test guidelines * Update test/README.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
This commit is contained in:
parent
9cb40dc99a
commit
86ebd8af80
10
test/README.md
Normal file
10
test/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Backend Testing Guidelines
|
||||
|
||||
- All the tests should test Backend functionalities. Frontend functionalities and e2e tests are done in Frontend.
|
||||
- Make use of pytest fixtures whenever it is possible. With fixtures, objects with high initialize durations are reused within tests, ex. a client session.
|
||||
- All test_data resides within _gradio/test_data_ and all test_files resides within test/test_files.
|
||||
- When doing network operations do not forget to make use of async to make tests faster.
|
||||
- Have clear class and function naming within the tests.
|
||||
- Short descriptions within test functions are great.
|
||||
- Library function docstrings is expected to contain an example, please add missing docstrings to the library while you are writing tests the related function.
|
||||
- Library docstring examples and descriptions are expected to align with tests, please fix divergent tests and library docstrings.
|
Loading…
Reference in New Issue
Block a user