Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 1.76 KB
Raw

How to make a contribution

This page addresses the guidelines for the following actions below:

  • How to clone the repository on your local machine
  • 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:

Fork it from GitHub GUI

Start by forking the repository

Clone it

git clone https://github.com/<your username>/modbus-acap.git

Create your feature branch

git switch -c <branch name>

Lint code after adding changes

See more details in LINT.md.

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 (PR)

Please consider the following guidelines before making a Pull Request:

  • Make sure that the sample code builds perfectly fine on your local system.
  • 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.

How to post an issue in the issue tracker

Please supply the following information in the issue:

  • Axis Camera model (e.g., Q1656) used when running the examples
  • Firmware version installed on the camera
  • Error(s) showed during building or running the example