Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Iox #910 quality declaration document #918

Merged

Conversation

dkroenke
Copy link
Member

@dkroenke dkroenke commented Sep 2, 2021

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Changelog updated in the unreleased section including API breaking changes
  4. Branch follows the naming format (iox-#123-this-is-a-branch)
  5. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  6. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. Relevant issues are linked
  8. Add sensible notes for the reviewer
  9. All checks have passed (except task-list-completed)
  10. Assign PR to reviewer

Notes for Reviewer

With this quality declaration document are the quality measures are made visible according to ROS REP 2004.
This document focus on the software quality of the iceoryx_hoofs, iceoryx_posh and iceoryx_binding_c packages.

In addition to quality level 2 the document shall also list the diff for reaching quality level 1 in ROS 2.
All Committers and PMC lead are added as reviewers for informational purpose.

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@dkroenke dkroenke added the documentation Improvements or additions to documentation label Sep 2, 2021
@dkroenke dkroenke self-assigned this Sep 2, 2021
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mossmaurice mossmaurice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great write-up, thanks! The current status-quo looks really good :-)

CHANGELOG.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
elfenpiff
elfenpiff previously approved these changes Sep 7, 2021
CHANGELOG.md Outdated Show resolved Hide resolved
tools/ci/build-test-ubuntu-with-latest-clang.sh Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
@dkroenke dkroenke force-pushed the iox-#910-quality-declaration-document branch 3 times, most recently from 3177d08 to 6c1a632 Compare September 22, 2021 14:04
@dkroenke dkroenke marked this pull request as ready for review September 23, 2021 11:22
@dkroenke dkroenke force-pushed the iox-#910-quality-declaration-document branch 2 times, most recently from 86aae32 to 2886e45 Compare September 23, 2021 12:48
@codecov
Copy link

codecov bot commented Sep 23, 2021

Codecov Report

Merging #918 (fa41575) into master (72a5cf7) will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #918      +/-   ##
==========================================
+ Coverage   77.51%   77.60%   +0.08%     
==========================================
  Files         335      336       +1     
  Lines       12267    12309      +42     
  Branches     1831     1831              
==========================================
+ Hits         9509     9552      +43     
  Misses       2131     2131              
+ Partials      627      626       -1     
Flag Coverage Δ
unittests 76.50% <ø> (+0.08%) ⬆️
unittests_timing 30.48% <ø> (+0.26%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
iceoryx_posh/source/roudi/process_manager.cpp 62.01% <0.00%> (-0.30%) ⬇️
iceoryx_binding_c/source/c_config.cpp 100.00% <0.00%> (ø)
iceoryx_hoofs/source/concurrent/loffli.cpp 85.29% <0.00%> (+5.88%) ⬆️

@dkroenke dkroenke force-pushed the iox-#910-quality-declaration-document branch from 2886e45 to 9bbcd71 Compare September 23, 2021 15:40
@dkroenke dkroenke force-pushed the iox-#910-quality-declaration-document branch from 9bbcd71 to 5a1ab18 Compare September 28, 2021 09:13
mossmaurice
mossmaurice previously approved these changes Sep 28, 2021
Copy link
Contributor

@mossmaurice mossmaurice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dkroenke dkroenke merged commit 460c7b0 into eclipse-iceoryx:master Sep 30, 2021
@dkroenke dkroenke deleted the iox-#910-quality-declaration-document branch September 30, 2021 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Quality Declaration Document
5 participants