g3log/PULL_REQUEST_TEMPLATE.md

27 lines
651 B
Markdown
Raw Permalink Normal View History

2020-06-19 21:48:32 +02:00
- [ ] **TDD**
New/modified code must be backed down with unit test - preferably TDD style development)
- [ ] **Documentation**
All new/modified functionality should be backed up with API documentation (API.markdown or README.markdown)
**Cross-Platform Testing**
2020-06-19 21:45:39 +02:00
- [ ] Travis-CI (Linux, OSX) + AppVeyor-CI (Windows)\
- [ ] *Optional:* Local/VM testing: Windows
- [ ] *Optional:* Local/VM testing: OSX
- [ ] *Optional:* Local/VM testing: Linux
2020-06-19 20:02:48 +02:00
**Testing Advice**
```bash
mkdir build; cd build; cmake -DADD_G3LOG_UNIT_TEST=ON ..
```
**Run Test Alternatives:**
- Cross-Platform: `ctest`
- or `ctest -V` for verbose output
- Linux: `make test`