1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 08:47:17 +01:00
SqMod/vendor/CPR/CONTRIBUTING.md
Sandu Liviu Catalin 4a6bfc086c Major plugin refactor and cleanup.
Switched to POCO library for unified platform/library interface.
Deprecated the external module API. It was creating more problems than solving.
Removed most built-in libraries in favor of system libraries for easier maintenance.
Cleaned and secured code with help from static analyzers.
2021-01-30 08:51:39 +02:00

1.2 KiB

Contributing to C++ Requests

Please fork this repository and contribute back using pull requests. Features can be requested using issues. All code, comments, and critiques are greatly appreciated.

Formatting

To avoid unproductive debates on formatting, this project uses clang-format to ensure a consistent style across all source files. Currently, clang-format 3.8 is the version of clang-format we use. The format file can be found here. To install clang-format on Ubuntu, run this:

apt-get install clang-format-3.8

To install clang-format on OS X, run this:

brew install clang-format

Note that brew might install a later version of clang-format, but it should be mostly compatible with what's run on the Travis servers.

To run clang-format on every source file, run this in the root directory:

./format-check.sh

This should indicate which files need formatting and also show a diff of the requested changes. More specific usage instructions can be found on the official LLVM website.