mirror of
https://github.com/KjellKod/g3log.git
synced 2024-12-12 10:23:50 +01:00
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
|
|
# PULL REQUEST DESCRIPTION
|
|
|
|
`ADD CONTENT HERE TO DESCRIBE THE PURPOSE OF THE PULL REQUEST`
|
|
|
|
|
|
# Formatting
|
|
- [ ] I am following the formatting style of the existing codebase.
|
|
|
|
_a clang-format configuration file is available in the root of g3log._
|
|
- _Use VSCode with clang-formatter or commandline:_
|
|
`clang-format -i path_to_file`
|
|
- _or recursive throughout the whole repo:_ `find . -iname "*.hpp" -o -iname "*.cpp" | xargs clang-format -i`
|
|
|
|
|
|
# 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
|
|
|
|
_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`
|