mirror of
https://github.com/QuasarApp/pe-parse.git
synced 2025-04-27 04:44:31 +00:00
2c775e5d6a
* pe-parser-library: Directory entry extraction Also runs clang-format on all library files. * dump-pe: Refactor, clang-format * pe-parser-library: Use enum for directory kinds * travis: Refactor * travis: Fixup stages * travis: Fix matrix * examples, pe-parser-library, pepy: clang-format * travis: Use minimal for lint * travis: Use find * clang-format: Remove old option * travis: More experimentation * travis: Move addons * travis: Remove coverity * travis: Hackery * travis: Move addons up * .travis: clang-format-8 * examples: clang-format * travis: Fix homebrew * CONTRIBUTING: Add contrib guidelines * travis: Build python ext, reenable coverity Remove old build files. * travis: Re-add coverity secret * travis: Build with coverity in a separate dir
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++11
|
|
* 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)
|