Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.78 KB

How to contribute

We'd love to accept your patches and contributions to this project. There are a just a few small guidelines you need to follow.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Carefully check your commits by compiling and running the test suite on your machine. You should not break the API, if you have to, detail why in your commit message.

  4. Any significant changes should always be accompanied by one ore more tests.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools. Please specify which project is concerned by your commit using the following syntax: [visp_tracker] file.cc: fix memory leak (close #N)

  6. Finally, push the commits to your fork and submit a pull request.