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 improve contributing md #1180

Conversation

FerdinandSpitzschnueffler
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler commented Mar 1, 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

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

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler added the documentation Improvements or additions to documentation label Mar 1, 2022
@codecov
Copy link

codecov bot commented Mar 1, 2022

Codecov Report

Merging #1180 (212b749) into master (6ca4d0a) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1180      +/-   ##
==========================================
+ Coverage   78.92%   78.94%   +0.02%     
==========================================
  Files         367      367              
  Lines       14627    14627              
  Branches     2045     2045              
==========================================
+ Hits        11544    11547       +3     
+ Misses       2412     2411       -1     
+ Partials      671      669       -2     
Flag Coverage Δ
unittests 78.15% <ø> (+<0.01%) ⬆️
unittests_timing 13.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%> (-2.86%) ⬇️
...e/iceoryx_hoofs/internal/concurrent/smart_lock.inl 92.45% <0.00%> (-1.89%) ⬇️
iceoryx_posh/source/roudi/port_manager.cpp 84.73% <0.00%> (+0.19%) ⬆️
iceoryx_hoofs/source/posix_wrapper/timer.cpp 63.90% <0.00%> (+0.82%) ⬆️
iceoryx_posh/source/mepoo/memory_manager.cpp 97.08% <0.00%> (+1.94%) ⬆️

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, few nitpicks

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
mossmaurice
mossmaurice previously approved these changes Mar 1, 2022
@mossmaurice mossmaurice changed the title Iox #743 improve contributing md iox-#743 improve contributing md Mar 1, 2022
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler force-pushed the iox-#743-improve-contributing-md branch from a99b9ae to 212b749 Compare March 1, 2022 17:18
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler requested review from MatthiasKillat and mossmaurice and removed request for dkroenke March 1, 2022 17:21
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler merged commit 259650c into eclipse-iceoryx:master Mar 1, 2022
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler deleted the iox-#743-improve-contributing-md branch March 1, 2022 19:16
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.

Improve documentation and website for v2.0
3 participants