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-#743 Add architecture article #1203

Merged

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Mar 2, 2022

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

  • Update .pumls for v2.0
  • Add architecture article

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
    • Each unit test case has a unique UUID
  • 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

@mossmaurice mossmaurice self-assigned this Mar 2, 2022
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Mar 2, 2022

Codecov Report

Merging #1203 (981d311) into master (6fbcea4) will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1203      +/-   ##
==========================================
- Coverage   79.00%   78.99%   -0.02%     
==========================================
  Files         370      370              
  Lines       14656    14682      +26     
  Branches     2045     2046       +1     
==========================================
+ Hits        11579    11598      +19     
- Misses       2407     2415       +8     
+ Partials      670      669       -1     
Flag Coverage Δ
unittests 78.21% <ø> (-0.03%) ⬇️
unittests_timing 13.89% <ø> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
...fs/include/iceoryx_hoofs/internal/cxx/helplets.inl 93.75% <0.00%> (-2.09%) ⬇️
iceoryx_posh/source/runtime/posh_runtime_impl.cpp 65.43% <0.00%> (+0.34%) ⬆️
iceoryx_hoofs/source/posix_wrapper/timer.cpp 63.90% <0.00%> (+0.82%) ⬆️
iceoryx_hoofs/source/posix_wrapper/file_lock.cpp 40.41% <0.00%> (+2.50%) ⬆️
iceoryx_hoofs/source/concurrent/loffli.cpp 91.42% <0.00%> (+5.71%) ⬆️

@mossmaurice mossmaurice removed the request for review from dkroenke March 2, 2022 20:55
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
MatthiasKillat
MatthiasKillat previously approved these changes Mar 3, 2022
@mossmaurice mossmaurice removed the request for review from elBoberido March 3, 2022 14:40
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
doc/website/concepts/architecture.md Outdated Show resolved Hide resolved
@mossmaurice mossmaurice merged commit b4fec12 into eclipse-iceoryx:master Mar 3, 2022
@mossmaurice mossmaurice deleted the iox-#743-add-architecture-article branch March 3, 2022 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation and website for v2.0
4 participants