diff options
| author | Tony Tam <149837+tonytamsf@users.noreply.github.com> | 2021-01-21 02:29:33 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-21 11:29:33 +0100 |
| commit | b951156b505966c714fda83606d5ee0161b17639 (patch) | |
| tree | e351331f443c393e898b2f755de4de38f3149669 /CONTRIBUTING.md | |
| parent | 41d23fa671a3ad7d417f4791c63d0f25634d725f (diff) | |
| download | antennapod-b951156b505966c714fda83606d5ee0161b17639.zip | |
tips on running tests when contributing (#4849)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7cb59fc2..075d5c53d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,3 +35,23 @@ Submit a pull request - Please do not upgrade dependencies or build tools unless you have a good reason for it. Doing so can easily introduce bugs that are hard to track down. - If you plan to do a change that touches many files (10+), please ask beforehand. This usually causes merge conflicts for other developers. - Please follow our code style. You can use Checkstyle within Android Studio using our [coniguration file](https://github.com/AntennaPod/AntennaPod/blob/develop/config/checkstyle/checkstyle-new-code.xml). + + +Testing and Verifying +-------------------------- +As a developer contributing to AntennaPod, we ask that you test the feature yourself manually and better yet, add unit and functional tests to any feature of bug you fix. + +### Running Unit Tests +* `./gradlew :core:testPlayDebugUnitTest` + +### Running Integration Tests + +#### Using Android Studio +* Create a configuration via 'Run->Edit Configurations...' + +<img width="768" alt="antennapod-run-tests" +src="https://user-images.githubusercontent.com/149837/105122859-e1317180-5a8b-11eb-8d45-d54a3b051a9b.png"> + +#### Using the command line +* Start an AVD or plug in your phone +* `sh .github/workflows/runTests.sh` |