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-#1295 Extend FAQ with more questions #1434

Merged
merged 4 commits into from
Jul 4, 2022

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Jun 29, 2022

Left-over from shortly after the Blueberry release

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

  • Add three new entries to the FAQ, which are often asked in issues

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 added the documentation Improvements or additions to documentation label Jun 29, 2022
@mossmaurice mossmaurice self-assigned this Jun 29, 2022
@codecov
Copy link

codecov bot commented Jun 29, 2022

Codecov Report

Merging #1434 (cc3eda0) into master (9794fbf) will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1434      +/-   ##
==========================================
- Coverage   78.74%   78.71%   -0.04%     
==========================================
  Files         377      377              
  Lines       14505    14505              
  Branches     2020     2020              
==========================================
- Hits        11422    11417       -5     
- Misses       2441     2443       +2     
- Partials      642      645       +3     
Flag Coverage Δ
unittests 78.37% <ø> (-0.04%) ⬇️
unittests_timing 14.92% <ø> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
iceoryx_hoofs/source/concurrent/loffli.cpp 85.71% <0.00%> (-5.72%) ⬇️
iceoryx_posh/source/mepoo/shared_chunk.cpp 93.33% <0.00%> (-3.34%) ⬇️
iceoryx_posh/source/roudi/port_manager.cpp 84.24% <0.00%> (-0.19%) ⬇️

doc/website/FAQ.md Outdated Show resolved Hide resolved
doc/website/FAQ.md Outdated Show resolved Hide resolved
doc/website/FAQ.md Show resolved Hide resolved
doc/website/FAQ.md Outdated Show resolved Hide resolved
doc/website/FAQ.md Show resolved Hide resolved
@elBoberido
Copy link
Member

Oh, while you are at it. Could you add a clarification that the d'tor of the data is not called to https://iceoryx.io/v2.0.2/getting-started/overview/#restrictions?

@mossmaurice mossmaurice force-pushed the iox-#1295-extend-faq branch from 7763a1c to db88121 Compare July 1, 2022 10:13
@dkroenke dkroenke mentioned this pull request Jul 1, 2022
21 tasks
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

Looks good. Just a bit more clarification regarding the destructor constraint

doc/website/getting-started/overview.md Outdated Show resolved Hide resolved
@elBoberido
Copy link
Member

@dkroenke can you please add the issue number to your commit

@dkroenke dkroenke force-pushed the iox-#1295-extend-faq branch from 5074003 to 7c8ef4c Compare July 1, 2022 16:11
@mossmaurice mossmaurice force-pushed the iox-#1295-extend-faq branch from 7c8ef4c to cc3eda0 Compare July 2, 2022 10:58
@mossmaurice mossmaurice requested a review from elBoberido July 2, 2022 10:58
@mossmaurice mossmaurice merged commit 20c83d8 into eclipse-iceoryx:master Jul 4, 2022
@mossmaurice mossmaurice deleted the iox-#1295-extend-faq branch July 4, 2022 09:14
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.

Release validation for v3.0
4 participants