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

[#2] Fill contributing.md file #50

Merged

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Dec 17, 2023

Notes for Reviewer

Pre-Review Checklist for the PR Author

  1. Add sensible notes for the reviewer
  2. PR title is short, expressive and meaningful
  3. Relevant issues are linked
  4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. Commits messages are according to this guideline
  7. Tests follow the best practice for testing
  8. Changelog updated in the unreleased section including API breaking changes
  9. Assign PR to reviewer
  10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Use either 'Closes #123' or 'Relates to #123' to reference the corresponding issue.

Relates to #2

@elfenpiff elfenpiff self-assigned this Dec 17, 2023
Copy link

codecov bot commented Dec 17, 2023

Codecov Report

Merging #50 (f05ce41) into main (b8485d3) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
- Coverage   77.88%   77.86%   -0.02%     
==========================================
  Files         171      171              
  Lines       18638    18638              
==========================================
- Hits        14516    14513       -3     
- Misses       4122     4125       +3     

see 1 file with indirect coverage changes

@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Dec 18, 2023
Copy link

@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! Looking forward to many rusty 🦀 people joining.

@elfenpiff elfenpiff merged commit d041800 into eclipse-iceoryx:main Dec 18, 2023
21 checks passed
@elfenpiff elfenpiff deleted the iox2-2-add-contributions-file branch December 18, 2023 15:22
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.

2 participants