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

Update PULL_REQUEST_TEMPLATE.md (#440)

Browse Source 
* Update PULL_REQUEST_TEMPLATE.md so it's easier to understand what a decent PR should look like
This commit is contained in:
Kjell Hedström. We are hiring @ Ganaz 2022-03-19 00:43:35 -06:00 committed by GitHub
parent 234b4ed70f
commit 52af38396f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
PULL_REQUEST_TEMPLATE.md
View File

@ -1,26 +1,30 @@
- [ ] **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**
- [ ] Travis-CI (Linux, OSX) + AppVeyor-CI (Windows)\
- [ ] *Optional:* Local/VM testing: Windows
- [ ] *Optional:* Local/VM testing: OSX
- [ ] *Optional:* Local/VM testing: Linux
***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
```
**Run Test Alternatives:**
_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