Skip to content

Commit 4c7e32e

Browse files
committed
chore(docs): add TESTING section to CONTRIBUTING [skip ci]
1 parent be1c322 commit 4c7e32e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
1. [General Hints](#general)
66
1. [Development / Editor Setup](#editors)
77
1. [Visual Studio Code (vscode)](#vscode)
8+
1. [Testing][#testing]
89
1. [Using Buildkit](#buildkit)
910
1. [Local HTTP(S) Caching Proxy](#caching)
1011
1. [Local S3 Server](#local-s3-server)
@@ -31,6 +32,27 @@ This repo includes VSCode settings that allow for a) editing inside a docker con
3132
1. Open your docker-diffusers-api folder, you'll get a popup in the bottom right that a dev container environment was detected, click "reload in container"
3233
1. Look for the "( ) Watch" on status bar and click it so it changes to "( ) XX Coverage"
3334

35+
<a name="testing"></a>
36+
## Testing
37+
38+
1. **Unit testing**: exists but is sorely lacking for now. If you use the
39+
recommended editor setup above, it's probably working already. However:
40+
41+
1. **Integation / E2E**: cover most features used in production.
42+
`pytest -s tests/integration`.
43+
The `-s` is optional but streams stdout so you can follow along.
44+
Add also `-k test_name` to test a specific test. E2E tests are LONG but you can
45+
greatly reduce subsequent run time by following the steps below for a
46+
[Local HTTP(S) Caching Proxy](#caching) and [Local S3 Server](#local-s3-server).
47+
48+
Docker-Diffusers-API follows Semantic Versioning. We follow the
49+
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
50+
standard.
51+
52+
* On a commit to `dev`, if all CI tests pass, a new release is made to `:dev` tag.
53+
* On a commit to `main`, if all CI tests pass, a new release with appropriate
54+
major / minor / patch is made, based on appropriate tags in the commit history.
55+
3456
<a name="buildkit"></a>
3557
## Using BuildKit
3658

0 commit comments

Comments
 (0)