mirror of
https://github.com/KjellKod/g3log.git
synced 2025-01-06 08:41:13 +01:00
52af38396f
* Update PULL_REQUEST_TEMPLATE.md so it's easier to understand what a decent PR should look like
31 lines
858 B
Markdown
31 lines
858 B
Markdown
|
|
***PULL REQUEST DESCRIPTION***
|
|
|
|
`ADD CONTENT HERE TO DESCRIBE THE PURPOSE OF THE PULL REQUEST`
|
|
|
|
**Testing Advice**
|
|
|
|
_step 1_
|
|
|
|
```bash
|
|
mkdir build; cd build; cmake -DADD_G3LOG_UNIT_TEST=ON ..
|
|
|
|
// linux/osx alternative, simply run: ./scripts/buildAndRunTests.sh
|
|
```
|
|
|
|
_step 2: use one of these alternatives to run tests:_
|
|
|
|
- Cross-Platform: `ctest`
|
|
- or `ctest -V` for verbose output
|
|
- Linux: `make test`
|
|
|
|
|
|
***CHECKLIST TO COMPLETE***
|
|
- [ ] **TDD**: New/modified code must be backed down with unit test - preferably _Test Driven Development_ style development)
|
|
- [ ] **Documentation**: All new/modified functionality should be backed up with API documentation (API.markdown or README.markdown)
|
|
|
|
|
|
**Cross-Platform Testing**
|
|
- [ ] CI GitActions: (Linux, OSX) + AppVeyor-CI (Windows)\
|
|
- [ ] Local/VM testing, at least one of the following: Windows, Linux, OSX
|