Skip to content

Fix typos across the project - #2538

Closed
antonkesy wants to merge 3 commits into
eclipse-iceoryx:mainfrom
antonkesy:fix-typos
Closed

Fix typos across the project#2538
antonkesy wants to merge 3 commits into
eclipse-iceoryx:mainfrom
antonkesy:fix-typos

Conversation

@antonkesy

@antonkesy antonkesy commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Notes for Reviewer

This PR fixes typos in docs, comments, and string literals. It should not change any behavior of the code.

It's quite huge (sorry), but should be fairly easy to check

If this is not suitable, needs changes, ... please let me know :)

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
  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

Checklist for the PR Reviewer

  • Consider a second reviewer for complex new features or larger refactorings
  • 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
  • All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

  • Closes TBD

@elBoberido

Copy link
Copy Markdown
Member

@antonkesy it seems some of the changes you made require to run clang-format on that files. Also, can you edit the commit messages and prepend iox-2305? #2305 is the issue number for small documentation fixes like the ones you did.

It also might not be clear to new contributors, but this repo is basically in maintenance mode and the development has fully shifted to iceoryx2. So while we appreciate your contribution, there will most probably no further major release from this repo. We would of course also appreciate if you look at the iceoryx2 repo for typos. I guess we also have plenty of them there.

@antonkesy antonkesy closed this Jul 29, 2026
@antonkesy
antonkesy deleted the fix-typos branch July 29, 2026 08:27
@elBoberido

Copy link
Copy Markdown
Member

@antonkesy I think we need to make it clear the the branch naming is not a hard requirement. For a first or one time contribution, this can be relaxed.

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.

2 participants