generic-library/g3log
1
0
Fork 0
mirror of https://github.com/KjellKod/g3log.git synced 2024-12-13 10:42:56 +01:00
Code Issues Projects Releases Wiki Activity

Pull request template is improved

Browse Source
This commit is contained in:
Kjell Hedström : Available for new Engineering Leadership and Engineering Opportunities 2020-06-19 12:02:48 -06:00 committed by GitHub
parent 6d0eb32ddb
commit 7f3159e17f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
PULL_REQUEST_TEMPLATE.md
View File

@ -1,4 +1,14 @@
* Follow TDD practice.
* All new and modified functionality should be backed up with unit tests.
* All new functionality should be backed up with API documentation (API.markdown or README.markdown)
* Windows, Ubuntu, OSX support must work. Please use local environment + the CI to verify this.
- [ ] Follow TDD practice. (new/modified code must be backed down with unit test - preferably TDD style development)
- [ ] All new/modified functionality should be backed up with API documentation (API.markdown or README.markdown)
- [ ] Cross Platform validation: Wcindows, Ubuntu, OSX support must work. Please use the CI to verify this. If possible using a local environment or VM during development can speed up your iterations.
**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`