Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

52 lines (43 loc) · 3.16 KB
Raw

Contribution Guidelines

Most of eProsima's products follow an open source model. As such, we are always listening to the community for issues, feature improvements and suggestions.

Submitting a pull request

If writing an issue does not do it for you because you just know what has to be done and how, and you have the energy and time to directly contribute to the project, submitting a pull request is your way to go. Please mind that by doing so, you accept to abide to the pull request process followed by eprosima, meaning:

  1. Modify one feature at a time. Avoid pull requests where several features or functionalities are implemented or modified at the same time. If you have many contributions, please split them in different pull requests.
  2. Submit your pull requests in separate branches. As for branch names, we normally use feature/* for adding functionality or refactors, hotfix/* for small fixes, and bugfix/* for larger parts that do not reflect reality and need to be corrected.
  3. Code should be formatted according to our Code Style Guide. We also provide an uncrustify configuration file to help in that regard.
  4. Contributors must sign-off each commit by adding a Signed-off-by: ... line at the end of commit messages. This certifies that they have the right to submit the code they are contributing to the project according to the Developer Certificate of Origin (DCO). Pull requests with unsigned commits will not pass the automated checks until unsigned commits have been amended.
  5. Test your changes before submission, and only submit "green" pull requests. Our Continuous Integration will still run the tests, but this way the process becomes smoother and the "Fixing errors" commits and re-runs are avoided. If you need any help setting up, please let us know by opening an issue. We will be happy to help you and also to improve the instructions for any repository if needed.
  6. Be prepared to receive criticism, and potentially tons of change requests. Please do not take criticism as personal, we really appreciate your contributing effort. To be merged into the master branch or the releases, a pull request must be approved by at least one reviewer with write access.
  7. Changes of the kind feature/* must be accompanied by a pull request to the appropriate documentation repo documenting the added functionality.
  8. Mind that LICENSE applies to all contributions made to this repository.

Licensing

Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.