How to make a contribution

This page addresses the guidelines for the following actions below.

How to clone the repository on your local machine

Please use the following commands to clone the examples repository on your local machine.

git clone https://github.com/AxisCommunications/acap3-examples.git

git checkout -b <branch_name>

git commit -a -m "Follow the conventional commit messages style to write this message"

git push origin <branch_name>

Please consider the following guidelines before making a Pull Request.

Please make sure that the sample code builds perfectly fine on your local system.
Make sure that all linters pass.
Follow the conventional commits message style in the commit messages
The PR will have to meet the sample code examples standard already available in the repository.
Explanatory comments related to code functions are required. Please write code comments for a better understanding of the code for other developers.
No PR will be accepted without having a well defined README (see examples in the repo) file for the sample code.

Please follow the guidelines below before posting an issue in the issue tracker.