Skip to content

Latest commit

 

History

History
65 lines (53 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

65 lines (53 loc) · 3.43 KB
Raw

What do I need to know to help?

If you are looking to help to with a code contribution, our project uses C, C++, Python and Bash shell scripting languages in the code. Extensive knowledge about V4L2 or OpenCV can also be helpful if you wish to contribute to this project.

Also, please note that any contribution you make towards this project is governed by the 3-clause BSD license copyright statement. This entails that to the extent possible under law, you transfer all copyright and related or neighboring rights of the code or documents you contribute to the project itself or its maintainers. Furthermore you also represent that you have the authority to perform the above waiver with respect to the entirety of your contributions.

How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!

  1. Find an issue that you are interested in addressing or a feature that you would like to add.
  2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/opencv_v4l2.
  3. Clone the repository to your local machine using git clone https://github.com/github-username/opencv_v4l2.git.
  4. Create a new branch for your fix using git checkout -b branch-name-here.
  5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
  6. Use git add to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
  7. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
  8. Push the changes to the remote repository using git push origin branch-name-here.
  9. Submit a pull request to the upstream repository.
  10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
  11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
  12. Wait for the pull request to be reviewed by a maintainer.
  13. Make changes to the pull request if the reviewing maintainer recommends them.
  14. Celebrate your success after your pull request is merged!

Can I contribute without coding?

Sure. You are welcome to use and test the provided applications and library on your device. If you face any issues, you can report them in the opencv_v4l2 issues page. Make sure to provide as much information as possible. You can use this link to create a bug report.

Or if you think this project can be improved upon by adding a new feature, you can create a feature request in the issues page using this link.