g3log/PULL_REQUEST_TEMPLATE.md

31 lines
690 B
Markdown
Raw Normal View History

2020-06-19 21:48:32 +02:00
# PULL REQUEST DESCRIPTION
2020-06-19 21:48:32 +02:00
`ADD CONTENT HERE TO DESCRIBE THE PURPOSE OF THE PULL REQUEST`
2020-06-19 21:48:32 +02:00
# Testing
- [ ] This new/modified code was covered by unit tests.
- [ ] (insight) Was all tests written using TDD (Test Driven Development) style?
- [ ] The CI (Windows, Linux, OSX) are working without issues.
- [ ] Was new functionality documented?
- [ ] The testing steps 1 - 2 below were followed
2020-06-19 20:02:48 +02:00
_step 1_
2020-06-19 20:02:48 +02:00
```bash
mkdir build; cd build; cmake -DADD_G3LOG_UNIT_TEST=ON ..
// linux/osx alternative, simply run: ./scripts/buildAndRunTests.sh
2020-06-19 20:02:48 +02:00
```
_step 2: use one of these alternatives to run tests:_
2020-06-19 20:02:48 +02:00
- Cross-Platform: `ctest`
- or `ctest -V` for verbose output
- Linux: `make test`