mirror of
https://github.com/QuasarApp/pe-parse.git
synced 2025-04-26 12:24:32 +00:00
e5ba0165ab
* Add simple test and corkami test suite using Catch2 * Enable testing with CMake option '-DPEPARSE_ENABLE_TESTING=ON'. * The simple test is extremely basic just as an example of using Catch2. * Corkami test suite is a git submodule within assets and the tests can be run with or without cloning it. You are able to configure CMake without the submodule and it will warn you that the tests are not included, and then it will pick them up automatically on next cmake rebuild. There are a few Corkami files which pe-parse is unable to process. They have been added as exceptions for now (just to get this merged), but we can open new issues to track them. This will also catch any regressions that could prevent the successful parsing of files that have been parse-able in the past. * Raise C++ standard from 11 to 17 for easier filesystem handling in tests. Also included CMake script for handling how std::filesystem is found/linked. * Rename directory 'test' to 'tests'. * Update README with testing instructions. * Catch2 is downloaded and built unless otherwise specified (undocumented, aside from reading CMake).
27 lines
1.0 KiB
Markdown
27 lines
1.0 KiB
Markdown
Contributing to pe-parse
|
|
========================
|
|
|
|
Hello, and welcome to the contributing guidelines for pe-parse!
|
|
|
|
For general building instructions, see the [README](README.md).
|
|
|
|
For licensing information, see the [LICENSE](LICENSE.txt) file. pe-parse includes a CLA; you will be
|
|
automatically prompted to sign it during your first PR.
|
|
|
|
## General contribution guidelines
|
|
|
|
* Your changes should be valid C++17
|
|
* Your changes should work across all major compiler vendors (GCC, Clang, MSVC) and all
|
|
major operating systems (Linux, macOS, Windows)
|
|
* Your changes should be auto-formatted with `clang-format -style=file`
|
|
* Your changes should not introduce *mandatory* third-party dependencies
|
|
|
|
## Adding features
|
|
|
|
Feature additions to either the parsing library or `dump-pe` are welcome!
|
|
|
|
Check out the following issue labels for some contribution ideas:
|
|
|
|
* [Enhancements](https://github.com/trailofbits/pe-parse/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
|
* [Hacktoberfest](https://github.com/trailofbits/pe-parse/issues?q=is%3Aissue+is%3Aopen+label%3Ahacktoberfest)
|