generic-library/g3log
1
0
Fork 0
mirror of https://github.com/KjellKod/g3log.git synced 2025-03-01 02:56:55 +01:00
Code Issues Projects Releases Wiki Activity
g3log/PULL_REQUEST_TEMPLATE.md
Kjell Hedström. We are hiring @ Ganaz 52af38396f
Update PULL_REQUEST_TEMPLATE.md (#440) 
* Update PULL_REQUEST_TEMPLATE.md so it's easier to understand what a decent PR should look like
2022-03-19 00:43:35 -06:00

858 B
Raw Blame History

PULL REQUEST DESCRIPTION

ADD CONTENT HERE TO DESCRIBE THE PURPOSE OF THE PULL REQUEST

Testing Advice

step 1

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