Skip to content

Commit d7d1f83

Browse files
rsanchez15rsanchez15
authored
Add contributing guidelines (#278)
* Add contributing guidelines Signed-off-by: RaulSanchez <raul@eprosima.com> * Update coverage section Signed-off-by: RaulSanchez <raul@eprosima.com> Signed-off-by: RaulSanchez <raul@eprosima.com>
1 parent 9a19073 commit d7d1f83

3 files changed

Lines changed: 136 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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+
* [Code Coverage](#code-coverage)
8+
* [Issues and Support](#issues-and-support)
9+
10+
## Contributions Licensing
11+
12+
Any contribution that you make to this repository will
13+
be under the Apache 2 License, as dictated by that
14+
[license](http://www.apache.org/licenses/LICENSE-2.0.html):
15+
16+
~~~
17+
5. Submission of Contributions. Unless You explicitly state otherwise,
18+
any Contribution intentionally submitted for inclusion in the Work
19+
by You to the Licensor shall be under the terms and conditions of
20+
this License, without any additional terms or conditions.
21+
Notwithstanding the above, nothing herein shall supersede or modify
22+
the terms of any separate license agreement you may have executed
23+
with Licensor regarding such Contributions.
24+
~~~
25+
26+
## Developer Certificate of Origin
27+
28+
Contributors must sign-off each commit by adding a `Signed-off-by: ...`
29+
line to commit messages to certify that they have the right to submit
30+
the code they are contributing to the project according to the
31+
[Developer Certificate of Origin (DCO)](https://developercertificate.org/).
32+
33+
## Code Coverage
34+
35+
All contributions to the project should increase the line code coverage whenever possible.
36+
Because of this, contributors are asked to locally run a coverage assessment that ensures that code coverage has increased when compared to the latest execution of the [nightly coverage CI job](https://app.codecov.io/gh/eProsima/DDS-Router).
37+
38+
## Issues and Support
39+
40+
*eProsima DDS Router* developers welcome all contributions, and we will be grateful if you follow the guidelines below while contributing to this project.
41+
42+
Also, this project classifies user issues in the following categories.
43+
Please, help us giving you a better support by opening your issue in the corresponding category.
44+
45+
### Issues
46+
47+
DDS Router issues are understood as bug reports and may be opened by anyone [here](https://github.com/eProsima/DDS-Router/issues/new/choose).
48+
Consequently, this section handles malfunctions in the current documented behavior of the library or non-compliances to the DDS specification.
49+
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.
50+
51+
It is really appreciated if all related information is provided so the issue may be reproduced.
52+
Otherwise, more information could be required in order to reproduce and solve the issue.
53+
If this is the case, the issue will be labeled with `need more info`.
54+
Please, be advised that in case that no response is received within a month, the issue would be closed due to inactivity.
55+
The issue may be reopened if the required information is provided.
56+
57+
### Feature request
58+
59+
Feature requests and improvements suggestions should be opened in the Ideas [discussion forum](https://github.com/eProsima/DDS-Router/discussions/new).
60+
Please, remember to select the corresponding category while opening the discussion.
61+
It is also encouraged to contact directly with [eProsima support team](https://github.com/eProsima/DDS-Router#getting-help) for a feature evaluation.
62+
63+
### Q&A
64+
65+
Questions about *eProsima DDS Router* behavior and features should be opened in the Q&A (Questions & Answers) [discussion forum](https://github.com/eProsima/DDS-Router/discussions/new).
66+
Please, remember to select the correct category while opening the discussion.
67+
It is strongly advised to first consult [eProsima DDS Router documentation](https://eprosima-dds-router.readthedocs.io/en/latest/) and previous Q&A in the forum.
68+
69+
### Support
70+
71+
Most user issues would fall in this category.
72+
*eProsima DDS Router* provides a lot of features and tuning the library for optimal behavior for each use case is not an easy task.
73+
These issues should be opened in the Support [discussion forum](https://github.com/eProsima/DDS-Router/discussions/new).
74+
Please, remember to select the corresponding category while opening the discussion.
75+
Please, take into account that *eProsima DDS Router* provides official support for the Tier 1 platforms, architectures and compilers defined [here](https://github.com/eProsima/DDS-Router/blob/master/PLATFORM_SUPPORT.md).
76+
Any other support should be opened in the next section: [Unofficial support](#unofficial-support)
77+
78+
### Unofficial support
79+
80+
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/DDS-Router/discussions/new).
81+
Please, remember to select the corresponding category while opening the discussion.
82+
If official support is wanted for any platform, architecture and/or compiler, please contact directly with [eProsima support team](https://github.com/eProsima/DDS-Router#getting-help) for an evaluation.

‎PLATFORM_SUPPORT.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Platform Support
2+
3+
This document reflects the level of support offered by *eprosima DDS Router* on different platforms as per the following
4+
definitions:
5+
6+
## Tier 1
7+
8+
Tier 1 platforms are subjected to our unit test suite and other testing tools on a frequent basis including continuous
9+
integration jobs, nightly jobs, packaging jobs, and performance testing.
10+
Errors or bugs discovered in these platforms are prioritized for correction by the development team.
11+
Significant errors discovered in Tier 1 platforms can impact release dates and we strive to resolve all known high
12+
priority errors in Tier 1 platforms prior to new version releases.
13+
14+
## Tier 2
15+
16+
Tier 2 platforms are subject to periodic CI testing which runs both builds and tests with publicly accessible results.
17+
The CI is expected to be run at least within a week of relevant changes for the current release of *DDS Router*.
18+
Installation instructions should be available and up-to-date in order for a platform to be listed in this category.
19+
Package-level binary packages may not be provided but providing a downloadable archive of the built workspace is
20+
encouraged.
21+
Errors may be present in released product versions for Tier 2 platforms.
22+
Known errors in Tier 2 platforms will be addressed subject to resource availability on a best effort basis and may or
23+
may not be corrected prior to new version releases.
24+
One or more entities should be committed to continuing support of the platform.
25+
26+
## Tier 3
27+
28+
Tier 3 platforms are those for which community reports indicate that the release is functional.
29+
The development team does not run the unit test suite or perform any other tests on platforms in Tier 3.
30+
Community members may provide assistance with these platforms.
31+
32+
## Platforms
33+
34+
|Architecture|Ubuntu Focal (20.04)|Ubuntu Jammy (22.04)|Windows 10 (VS2019)|Windows 10 (VS2022)|Debian Buster (10)|
35+
|------------|--------------------|--------------------|-------------------|-------------------|------------------|
36+
|amd64 |Tier 1 |Tier 1 |Tier 1 |Tier 1 |Tier 3 |
37+
|arm64 |Tier 3 | | | |Tier 3 |
38+
39+
## Compilers
40+
41+
Tier 1 compilers and minimum supported versions:
42+
43+
* GCC 9
44+
* Clang 12
45+
* MSVC v142 (Visual Studio 2019)
46+
* MSVC v143 (Visual Studio 2022)
47+
48+
Tier 3 compilers:
49+
50+
* MSVC v141 (Visual Studio 2017)

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,3 +231,7 @@ can be run with the following command:
231231
```bash
232232
colcon test --packages-select-regex ddsrouter --event-handler=console_direct+
233233
```
234+
235+
## Getting Help
236+
237+
If you need support you can reach us by mail at `support@eProsima.com` or by phone at `+34 91 804 34 48`.

0 commit comments

Comments
 (0)