added readme for unit tests

This commit is contained in:
Charlie Kindel
2020-06-07 22:20:12 -06:00
committed by BDisp
parent 3fbaacb28a
commit 225fe09f0e

View File

@@ -2,13 +2,4 @@
`Terminal.Gui` uses [xunit](https://xunit.net/) for automated unit tests run automatically with Github Actions.
## Notes
* Running tests in parallel is disabled because `Application` is a singleton. Do not change those settings.
## Guidelines for Adding More Tests
1. Do. Please. Add lots.
2. Structure the tests by class. Name the test classes in the form of `ClassNameTests` and the file `ClassNameTests.cs`.
3. The test functions themselves should have descriptive names like `TestBeginEnd`.
4. IMPORTANT: Remember `Application` is a static class (singleton). You must clean up after your tests by calling `Application.Shutdown`.
See the [Testing wiki](https://github.com/migueldeicaza/gui.cs/wiki/Testing) for details on how to add more tests.