eclipse-iceoryx / eclipse-iceoryx/iceoryx

Fine grained qualitvy level for components in iceoryx_hoofs

Open
#2,182 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
2.2k
Forks
492
Avg merge
18h 57m
Merged PRs (30d)
1

Description

## Brief feature description

As decided in the developer meetup from 2023-12-05, `iceoryx_dust` was merged back to `iceoryx_hoofs`. As a result, we need to have a more fine grained list of the quality levels for the components in iceoryx_hoofs.

https://github.com/eclipse-iceoryx/iceoryx/wiki/2023-12-05-Eclipse-iceoryx-developer-meetup#minutes

## Detailed information

It is upon downstream to decide which classes to use, we as upstream just need to make downstream aware of the quality level of each header.

This can be done by a matrix like the following (just a suggestion, TBD)

| Component | Coverage | clang-tidy | Axivion | ... |
|--------------------|----------|------------|---------|-----|
| iox/vector | ~100% | ✅ | ✅ | |
| iox/detail/convert | ~80% | ✅ | ❌ | |

If we include tools like Axivion in the matrix, we also need to state the rules which are followed else it is not possible for upstream to cooperate. It is totally fine though if this is just something that downstream adds but then it cannot be a criteria in the matrix.

**Note:** This was carved out of #2130

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.