Skip to content

Thank you for your interest in CppBind project contribution! Please refer to the following sections on how to contribute code and bug reports.

Reporting bugs

Before submitting a question or reporting a bug, please take a moment of your time and ensure that your issue isn't already discussed in the project documentation provided at [CppBind documentation][https://cppbind.io/] or in the Github issue tracker . If you have identified a previously unknown problem, it's essential that you submit a self-contained and minimal piece of code that reproduces the problem. The bugs need to be reported in Gihub issue tracker, with “bug” label on them. In the Comment section, clearly explain what was your expectation, and what is the actual result of the execution. Try to isolate the function(s) that malfunction, attach the code snippets that can be easily compiled and run in isolation. From the same issue tracker, You can also ask questions to CppBind code owners, by using “question” label while creating the Issue.

Pull requests

Contributions are submitted, reviewed, and accepted using GitHub pull requests. Please refer to this article for details and adhere to the following rules to make the process as smooth as possible: - Make a new branch for every feature you're working on. - Make small and clean pull requests that are easy to review but make sure they do add value by themselves. - While contributing, please, follow the Style Guide for Python Coding defined as PEP 8. - Add tests for any new functionality and run the test suite to ensure that no existing features break: 

pytest ./src/test
- Also make sure to run end to end tests under examples/primitives with the following command: 
bazel test //... --test_output=all
- Every pull request needs to have at least 2 approvals before being merged. The mandatory approvers are code owners of the repository. - Merging is getting done by CppBind code owners, who are in charge of the tool stability and maintainability.

Release cycle

There is no fixed releases cadence for CppBind, the new fixes/enhancements will be published on-demand. The release train will take all the merges done after the last release, and generate a new release tag for them, with Semantic Versioning rules. The new released package will be published Release Notes will be located in the Github Releases file, with the latest first order.

Licensing of contributions

CppBind is provided under a MIT license that can be found in the LICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

Last update: December 1, 2022