umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Code Issues Wiki Activity

Explain how to test and dialyze

Browse source
This commit is contained in:
Loïc Hoguin 2013-08-27 17:51:25 +02:00
parent bbee34fe16
commit fe7cc08daf
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -127,6 +127,26 @@ Committing
You MUST ensure that all commits pass all tests and do not have extra You MUST ensure that all commits pass all tests and do not have extra
Dialyzer warnings. Dialyzer warnings.
Running tests is fairly straightforward.
``` bash
make tests
```
Running Dialyzer requires some initial setup. You need to build the PLT
file that Dialyzer will use for its analysis. This is a one-time operation.
Dialyzer will take care of updating that file when needed.
``` bash
make build-plt
```
Once that is done, you can run Dialyzer.
``` bash
make dialyze
```
You MUST put all the related work in a single commit. Fixing a bug is one You MUST put all the related work in a single commit. Fixing a bug is one
commit, adding a feature is one commit, adding two features is two commits. commit, adding a feature is one commit, adding two features is two commits.