|
| 1 | +# Contributing to ROS RealSense™ Project |
| 2 | + |
| 3 | +Third-party patches and contributions are welcome. We do require |
| 4 | +you read and agree to the Contribution License Agreement below. |
| 5 | + |
| 6 | +## Contribution License Agreement |
| 7 | + |
| 8 | +The Intel® RealSense™ ROS Project is developed and distributed under |
| 9 | +a BSD license as noted in [camera/licenses/License.txt](../camera/licenses/License.txt). |
| 10 | + |
| 11 | +By making a contribution to this project, I certify that: |
| 12 | + |
| 13 | +(a) The contribution was created in whole or in part by me and I |
| 14 | +have the right to submit it under the open source license |
| 15 | +indicated in the file; or |
| 16 | + |
| 17 | +(b) The contribution is based upon previous work that, to the best |
| 18 | +of my knowledge, is covered under an appropriate open source |
| 19 | +license and I have the right under that license to submit that |
| 20 | +work with modifications, whether created in whole or in part |
| 21 | +by me, under the same open source license (unless I am |
| 22 | +permitted to submit under a different license), as indicated |
| 23 | +in the file; or |
| 24 | + |
| 25 | +(c) The contribution was provided directly to me by some other |
| 26 | +person who certified (a), (b) or (c) and I have not modified |
| 27 | +it. |
| 28 | + |
| 29 | +(d) I understand and agree that this project and the contribution |
| 30 | +are public and that a record of the contribution (including all |
| 31 | +personal information I submit with it, including my sign-off) is |
| 32 | +maintained indefinitely and may be redistributed consistent with |
| 33 | +this project or the open source license(s) involved. |
| 34 | + |
| 35 | +# Contribution Prerequisites |
| 36 | + |
| 37 | +* Create a [GitHub account](https://github.com/join) if you do not already have one. |
| 38 | +* Search the existing [GitHub Issues](../../../issues) |
| 39 | +to see if your contribution is already documented. |
| 40 | + * Submit a [new GitHub Issue](../../../issues/new) if one does not exist. |
| 41 | + * Complete the provided template with your system configuration. |
| 42 | + * For Bug fixes, include directions on how to reproduce the problem. |
| 43 | + * For new functionality or features, please describe in detail the requirements. |
| 44 | +* [Create a Fork](../../../fork) of the repository on GitHub for your contribution. |
| 45 | + |
| 46 | +# Submitting Changes |
| 47 | + |
| 48 | +* Create a Topic branch for your work. |
| 49 | + * Base the topic branch on the ROS development branch `<ros release>-devel`. |
| 50 | +* Ensure changes follow the [ROS coding Style Guide](http://wiki.ros.org/StyleGuide) |
| 51 | +* Each commit needs to be functional/compile by itself. |
| 52 | +* Follow [Git Commit Guidelines](https://git-scm.com/book/ch5-2.html#Commit-Guidelines) |
| 53 | +regarding commit formatting. |
| 54 | + * Check for unnecessary whitespace with `git diff --check` before committing. |
| 55 | +* Rebase commits to squash where appropriate. |
| 56 | +* Verify the Test cases found in the package 'test' directory are passing. |
| 57 | + * Changes with new functionality should include new test cases. |
| 58 | +* Submit a [Pull Request](../../../compare) to the repository. |
| 59 | + * Ensure that it is flagged as "Able to merge", if not you may need to rebase your Fork. |
| 60 | + * List the Issues fixed by the Pull Request. |
| 61 | + |
| 62 | +### Monitor Your Pull Request |
| 63 | + |
| 64 | +* The maintainers attempt to review all Pull Requests in a timely manner; worse case |
| 65 | +is once per week. |
| 66 | +* If maintainers request changes or additional information for your Pull Request, the |
| 67 | +expectation is the submitter replies within two weeks. |
| 68 | +* Pull Requests may be closed without being merged if there is no submitter response after 3+ weeks. |
| 69 | + |
| 70 | +# Contribution Resources |
| 71 | + |
| 72 | +* [Create a GitHub account](https://github.com/join) |
| 73 | +* [GitHub Pull Request documentation](https://help.github.com/articles/using-pull-requests) |
| 74 | +* [ROS coding Style Guide](http://wiki.ros.org/StyleGuide) |
| 75 | +* [Git Commit Guidelines](https://git-scm.com/book/ch5-2.html#Commit-Guidelines) |
0 commit comments