Skip to content

Commit

Permalink
docs: Add a note on flaky tests to Contributing (getsentry#2161)
Browse files Browse the repository at this point in the history
  • Loading branch information
philipphofmann authored Sep 15, 2022
1 parent aacfd57 commit fcd5c6e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ Test can either be ran inside from Xcode or via
make test
```

### Flaky tests

If you see a test being flaky, you should ideally fix it immediately. If that's not feasible, you can disable the test in the test scheme, add a suffix _disabled to the test, so it's clear when looking at the test that it is disabled, and create a GH issue with the label flaky test. Disabling the test in the scheme has the advantage that the test report will state "X tests passed, Y tests failed, Z tests skipped".

## Code Formatting
Please follow the convention of removing the copyright code comments at the top of files. We only keep them inside [SentryCrash](/SentryCrash/),
as the code is based on [KSCrash](https://github.com/kstenerud/KSCrash).
Expand Down

0 comments on commit fcd5c6e

Please sign in to comment.