Skip to content

Latest commit

 

History

History
29 lines (27 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

29 lines (27 loc) · 1.59 KB

Contributing to drone_toolbox

This repository follows the GitHub flow as described here.

When contributing, take the following steps:

  1. Fork the project.
  2. Clone the forked project.
  3. Check out the devel branch:
    git checkout devel
    
  4. Create a feature branch:
    git checkout -b descriptive-branch-name
    
  5. Edit, build and test the code. Some currently used guidelines for C++:
    MyClassName
    myFunctionName
    my_variable_name
    my_private_variable_name_
    
  6. Commit your changes. In case the commit fixes an issue, include the corresponding issue number with prefix '#' (e.g., #4).
  7. Push your changes.
  8. Make a pull request to merge your changes into the devel branch.

The following Git branching model is used:

  • master is stable and tested.
  • devel could be unstable, because it is subject to development via feature branches.
  • Feature branches (e.g., my-feature-branch) are used to develop new functionality, to be merged into devel via a pull request.