Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.59 KB

p11-kit -- Information about our contribution rules and coding style

Test suite

New functionality should be accompanied by a test case which verifies the correctness of p11-kit's operation on successful use of the new functionality, as well as on failure cases. The p11-kit test suite is run on "ninja test" if you use meson for building, or on "make check" if you use autotools.

Bug fixes should also come with a test case that exercises the code path that previously failed to operate. This prevents future regressions.

Coding style

In general, use the Linux kernel coding style, except that we put a space between function name and open parenthesis.

API documentation

Use gtk-doc for API documentation.

Library symbol versioning

We use the libtool versioning scheme to ensure ABI compatibility. If you add a new API function, update libp11-kit.map and libp11-kit-*.dll.def accordingly.

Resources: