|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +The following documents constitutes a set of guidelines to which contributors must adhere. |
| 4 | + |
| 5 | +* [Contributions Licensing](#contributions-licensing) |
| 6 | +* [Developer Certificate of Origin](#developer-certificate-of-origin) |
| 7 | +* [Issues and Support](#issues-and-support) |
| 8 | + |
| 9 | +## Contributions Licensing |
| 10 | + |
| 11 | +Any contribution that you make to this repository will |
| 12 | +be under the Apache 2 License, as dictated by that |
| 13 | +[license](http://www.apache.org/licenses/LICENSE-2.0.html): |
| 14 | + |
| 15 | +~~~ |
| 16 | +5. Submission of Contributions. Unless You explicitly state otherwise, |
| 17 | + any Contribution intentionally submitted for inclusion in the Work |
| 18 | + by You to the Licensor shall be under the terms and conditions of |
| 19 | + this License, without any additional terms or conditions. |
| 20 | + Notwithstanding the above, nothing herein shall supersede or modify |
| 21 | + the terms of any separate license agreement you may have executed |
| 22 | + with Licensor regarding such Contributions. |
| 23 | +~~~ |
| 24 | + |
| 25 | +## Developer Certificate of Origin |
| 26 | + |
| 27 | +Contributors must sign-off each commit by adding a `Signed-off-by: ...` |
| 28 | +line to commit messages to certify that they have the right to submit |
| 29 | +the code they are contributing to the project according to the |
| 30 | +[Developer Certificate of Origin (DCO)](https://developercertificate.org/). |
| 31 | + |
| 32 | +## Issues and Support |
| 33 | + |
| 34 | +*eProsima Fast DDS* developers welcome all contributions, and we will be grateful if you follow the guidelines below while contributing to this project. |
| 35 | +Firs of all, there are several products related with Fast DDS. |
| 36 | +Please, open the issue in the corresponding repository: |
| 37 | + |
| 38 | +- [Fast DDS](https://github.com/eProsima/Fast-DDS) |
| 39 | +- [Fast DDS documentation](https://github.com/eProsima/Fast-DDS-docs/issues/new) |
| 40 | +- [Fast DDS-Gen](https://github.com/eProsima/Fast-DDS-Gen/issues/new) |
| 41 | +- [Fast DDS Python](https://github.com/eProsima/Fast-DDS-python) |
| 42 | +- [Foonathan memory vendor](https://github.com/eProsima/foonathan_memory_vendor/issues/new) |
| 43 | +- [Fast CDR](https://github.com/eProsima/Fast-CDR/issues/new) |
| 44 | +- [Shapes Demo](https://github.com/eProsima/ShapesDemo/issues/new) |
| 45 | +- [ROS 2 Fast DDS RMW](https://github.com/ros2/rmw_fastrtps/issues/new) |
| 46 | +- [Fast DDS Statistics Backend](https://github.com/eProsima/Fast-DDS-statistics-backend/issues/new) |
| 47 | +- [Fast DDS Monitor](https://github.com/eProsima/Fast-DDS-monitor/issues/new) |
| 48 | +- [DDS Router](https://github.com/eProsima/DDS-Router/issues/new) |
| 49 | + |
| 50 | +Also, this project classifies user issues in the following categories. |
| 51 | +Please, help us giving you a better support by opening your issue in the corresponding category. |
| 52 | + |
| 53 | +### Issues |
| 54 | + |
| 55 | +Issues are understood as bug reports and may be opened by anyone [here](https://github.com/eProsima/Fast-DDS-python/issues/new). |
| 56 | +Consequently, this section handles malfunctions in the current documented behavior of the library. |
| 57 | +If you are unsure on whether your experienced behavior falls into this category, please open a ticket in the [Support](#support) discussion forum and, if it is a malfunction, an issue will be opened on your behalf with the provided report. |
| 58 | + |
| 59 | +### Feature request |
| 60 | + |
| 61 | +Feature requests and improvements suggestions should be opened in the Ideas [discussion forum](https://github.com/eProsima/Fast-DDS/discussions/new). |
| 62 | +Please, remember to select the corresponding category while opening the discussion. |
| 63 | +It is also encouraged to contact directly with [eProsima support team](https://github.com/eProsima/Fast-DDS#getting-help) for a feature evaluation. |
| 64 | + |
| 65 | +### Q&A |
| 66 | + |
| 67 | +Questions about *eProsima Fast DDS* behavior and features should be opened in the Q&A (Questions & Answers) [discussion forum](https://github.com/eProsima/Fast-DDS-python/discussions/new?category=ideas). |
| 68 | +Please, remember to select the correct category while opening the discussion. |
| 69 | +It is strongly advised to first consult [eProsima Fast DDS Python API reference](https://fast-dds.docs.eprosima.com/en/latest/fastdds/python_api_reference/python_api_reference.html) and previous Q&A in the forum. |
| 70 | + |
| 71 | +### Support |
| 72 | + |
| 73 | +Most user issues would fall in this category. |
| 74 | +*eProsima Fast DDS* provides a lot of features and tuning the library for optimal behavior for each use case is not an easy task. |
| 75 | +These issues should be opened in the Support [discussion forum](https://github.com/eProsima/Fast-DDS-python/discussions/new?category=support). |
| 76 | +Please, remember to select the corresponding category while opening the discussion. |
| 77 | +Please, take into account that *eProsima Fast DDS* provides official support for the Tier 1 platforms, architectures and compilers defined [here](https://github.com/eProsima/Fast-DDS/blob/master/PLATFORM_SUPPORT.md). |
| 78 | +Any other support should be opened in the next section: [Unofficial support](#unofficial-support) |
| 79 | + |
| 80 | +### Unofficial support |
| 81 | + |
| 82 | +Any issue related with a non-officially supported platform, architecture and/or compiler should be opened in the Unofficial support [discussion forum](https://github.com/eProsima/Fast-DDS-python/discussions/new?category=unofficial-support). |
| 83 | +Please, remember to select the corresponding category while opening the discussion. |
| 84 | +If official support is wanted for any platform, architecture and/or compiler, please contact directly with [eProsima support team](https://github.com/eProsima/Fast-DDS#getting-help) for an evaluation. |
0 commit comments