Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.71 KB

How to make a contribution

This page addresses the guidelines for the following actions below.

  • How to clone the repo.
  • How to make a good Pull Request (PR)
  • How to Post an issue in the issue tracker

How to clone the repository on your local machine

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

Clone it

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

Create your feature branch

git checkout -b <branch_name>

Commit your changes

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

Push to the branch

git push origin <branch_name>

Make a Pull request from GitHub GUI.

How to make a good Pull request

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.

How to post an issue in the issue tracker

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

  • Axis Camera model (e.g., MQ1615) used to execute the examples
  • Firmware version installed on the camera
  • Error(s) showed during compiling the source code