|
| 1 | +# Contributing Guidelines |
| 2 | +Thank you for your interest in contributing to `ros2_control_demos`. |
| 3 | +Whether it's a bug report, new feature, correction, or additional |
| 4 | +documentation, we greatly value feedback and contributions from our community. |
| 5 | + |
| 6 | +Please read through this document before submitting any issues or pull requests to ensure we have all the necessary |
| 7 | +information to effectively respond to your bug report or contribution. |
| 8 | + |
| 9 | + |
| 10 | +## Reporting Bugs/Feature Requests |
| 11 | +We welcome you to use the GitHub issue tracker to report bugs or suggest features. |
| 12 | + |
| 13 | +When filing an issue, please check [existing open][issues], or [recently closed][closed-issues], issues to make sure |
| 14 | + somebody else hasn't already reported the issue. |
| 15 | +Please try to include as much information as you can. Details like these are incredibly useful: |
| 16 | + |
| 17 | +* A reproducible test case or series of steps |
| 18 | +* The version of our code being used |
| 19 | +* Any modifications you've made relevant to the bug |
| 20 | +* Anything unusual about your environment or deployment |
| 21 | + |
| 22 | + |
| 23 | +## Contributing via Pull Requests |
| 24 | +Contributions via pull requests are much appreciated. |
| 25 | +Before sending us a pull request, please ensure that: |
| 26 | + |
| 27 | +1. You are working against the latest source on the *master* branch. |
| 28 | +2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. |
| 29 | +3. You open an issue to discuss any significant work - we would hate for your time to be wasted. |
| 30 | + |
| 31 | +To send us a pull request, please: |
| 32 | + |
| 33 | +1. Fork the repository. |
| 34 | +2. Modify the source; please focus on the specific change you are contributing. |
| 35 | + If you also reformat all the code, it will be hard for us to focus on your change. |
| 36 | +3. Ensure local tests pass. |
| 37 | +4. Commit to your fork using clear commit messages. |
| 38 | +5. Send a pull request, answering any default questions in the pull request interface. |
| 39 | +6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. |
| 40 | + |
| 41 | +GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and |
| 42 | +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). |
| 43 | + |
| 44 | + |
| 45 | +## Finding contributions to work on |
| 46 | +Looking at the existing issues is a great way to find something to contribute on. |
| 47 | +As this project, by default, uses the default GitHub issue labels |
| 48 | + (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'][help-wanted] issues |
| 49 | + is a great place to start. |
| 50 | + |
| 51 | + |
| 52 | +Any contribution that you make to this repository will |
| 53 | +be under the Apache 2 License, as dictated by that |
| 54 | +[license](http://www.apache.org/licenses/LICENSE-2.0.html): |
| 55 | + |
| 56 | +~~~ |
| 57 | +5. Submission of Contributions. Unless You explicitly state otherwise, |
| 58 | + any Contribution intentionally submitted for inclusion in the Work |
| 59 | + by You to the Licensor shall be under the terms and conditions of |
| 60 | + this License, without any additional terms or conditions. |
| 61 | + Notwithstanding the above, nothing herein shall supersede or modify |
| 62 | + the terms of any separate license agreement you may have executed |
| 63 | + with Licensor regarding such Contributions. |
| 64 | +~~~ |
| 65 | + |
| 66 | +[issues]: https://github.com/stack-of-tasks/odri_gz_ros2_control_demos/issues |
| 67 | +[closed-issues]: https://github.com/stack_of_tasks/odri_gz_ros2_control_demos/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20 |
| 68 | +[help-wanted]: https://github.com/stack_of_tasks/odri_gz_ros2_control_demos/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 |
| 69 | + |
0 commit comments