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-#533 Add Installation guide after building. #534

Merged

Conversation

BH1SCW
Copy link
Contributor

@BH1SCW BH1SCW commented Feb 1, 2021

Signed-off-by: Fanjun Kong bh1scw@gmail.com

Pre-Review Checklist for the PR Author

  1. Branch follows the naming format (iox-#123-this-is-a-branch)
  2. 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)
  3. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  4. Relevant issues are linked
  5. Add sensible notes for the reviewer
  6. All checks have passed
  7. 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
  • 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

Post-review Checklist for the Eclipse Committer

  1. All checkboxes in the PR checklist are checked or crossed out
  2. Merge

References

  • Closes TBD

Fixes #533"

@BH1SCW BH1SCW force-pushed the iox-#533-installation-guide branch 2 times, most recently from 82d7ce5 to 77c045b Compare February 1, 2021 06:11
Signed-off-by: Fanjun Kong <bh1scw@gmail.com>
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Feb 1, 2021
@mossmaurice
Copy link
Contributor

Thanks for your contribution! :-)
Could you go through the list "Pre-Review Checklist for the PR Author" and tick the checkboxes? Please also add a link e.g. "Fixes #533" at the very bottom of the pull request description.

@BH1SCW
Copy link
Contributor Author

BH1SCW commented Feb 2, 2021

Thanks for your contribution! :-)
Could you go through the list "Pre-Review Checklist for the PR Author" and tick the checkboxes? Please also add a link e.g. "Fixes #533" at the very bottom of the pull request description.

Thanks for your advice:) I have finished all above, could you help to check again?
Best wishes.

Copy link
Member

@dkroenke dkroenke left a comment

Choose a reason for hiding this comment

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

Only one formal point:
You can use the bulletpoint Closes TBD in the PR Template for linking to the corresponding issue. This would come here then with Closes #533.
Using the keyword Fixes is of course also valid.

@dkroenke dkroenke merged commit d3aa3d3 into eclipse-iceoryx:master Feb 2, 2021
@BH1SCW
Copy link
Contributor Author

BH1SCW commented Feb 3, 2021

Hi dkroenke,
I will keep your advice in mind for the next time.
Thanks a bunch!

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 how to install after build to guide.
3 participants