Contributing - abbyssoul/libsolace GitHub Wiki
Solace is an open source project distributed under Apache licence. Contributions to the project highly encouraged. To contribute please open a Pull request against project’s main repository to get the contribution via core review process. In order for the contribution to be accepted the PR should not compromise code quality as ensured by acceptance criteria.
Before raising a PR please test the code quality locally by running:
make codecheck
to verify that code satisfies coding standards
make test
to make sure that no existing tests has been broken
make verify
to make sure that code doesn’t leak memory
Please note that thouse tests are done using freely available tools which can not guaranty that all 100% defects are checked. That means this test are required but no substitute for good engineering practices and code review.
Acceptance criteria
- Compilation by target compilers with no warnings.
- All library features must have 100% Unit test coverage.
make codecheck
andmake verify
produce no errors.- Coverity scan finds no new defects.
Licence note
Please note that by contributing the code you are agree to make your contribution part of the open source project and to be distributed under Apache license.