-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
187 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## Notes for Reviewer | ||
<!-- Items in addition to the checklist below that the reviewer should look for --> | ||
|
||
## Pre-Review Checklist for the PR Author | ||
|
||
* [ ] Add sensible notes for the reviewer | ||
* [ ] PR title is short, expressive and meaningful | ||
* [ ] Relevant issues are linked in the [References](#references) section | ||
* [ ] Every source code file has a copyright header with `SPDX-License-Identifier: Apache-2.0 OR MIT` | ||
* [ ] Branch follows the naming format (`rmw-iox2-123-implement-graph-api`) | ||
* [ ] Commit messages have the issue ID (`[#123] Add posix ipc example`) | ||
* [ ] Tests exist for new behavior | ||
* [ ] Changelog updated [in the unreleased section][changelog] including API breaking changes | ||
* [ ] Assign PR to reviewer | ||
|
||
[changelog]: https://github.com/ekxide/rmw_iceoryx2/blob/main/doc/release-notes/unreleased.md | ||
|
||
## 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 | ||
|
||
* [ ] All open points are addressed and tracked via issues | ||
|
||
## References | ||
|
||
<!-- Use either 'Closes #123' or 'Relates to #123' to reference the corresponding issue. --> | ||
|
||
Closes # <!-- Add issue number after '#' --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# rmw_iceoryx2 v?.?.? | ||
|
||
## [vx.x.x](https://github.com/ekxide/rmw_iceoryx2/tree/vx.x.x) | ||
|
||
[Full Changelog](https://github.com/ekxide/rmw_iceoryx2/compare/vx.x.x...vx.x.x) | ||
|
||
### Features | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Bugfixes | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Refactoring | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Workflow | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### New API features | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### API Breaking Changes | ||
|
||
1. Example | ||
|
||
```cpp | ||
// old | ||
auto fuu = Hello::is_it_me_you_re_looking_for(); | ||
|
||
// new | ||
auto fuu = Hypnotoad::all_glory_to(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# rmw_iceoryx2 v?.?.? | ||
|
||
## [vx.x.x](https://github.com/ekxide/rmw_iceoryx2/tree/vx.x.x) | ||
|
||
[Full Changelog](https://github.com/ekxide/rmw_iceoryx2/compare/vx.x.x...vx.x.x) | ||
|
||
### Features | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Bugfixes | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Refactoring | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### Workflow | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### New API features | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) | ||
|
||
### API Breaking Changes | ||
|
||
1. Example | ||
|
||
```cpp | ||
// old | ||
auto fuu = Hello::is_it_me_you_re_looking_for(); | ||
|
||
// new | ||
auto fuu = Hypnotoad::all_glory_to(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# rmw_iceoryx2 v0.1.0 | ||
|
||
## [v0.1.0](https://github.com/ekxide/rmw_iceoryx2/tree/v0.1.0) | ||
|
||
[Full Changelog](https://github.com/ekxide/rmw_iceoryx2/commits/v0.1.0) | ||
|
||
### Features | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Add boilerplate for RMW implementation | ||
* Implement RMW context/node/guard condition/waitset/log/gid functions | ||
* Implement loan & copy functionality for publisher/subscriber | ||
* Implement RMW graph functions as much as possible with existing [`iceoryx2`](https://github.com/eclipse-iceoryx/iceoryx2) capabilities | ||
* Add helper scripts for measuring [`rmw_iceoryx2`](https://github.com/ekxide/rmw_iceoryx2) performance with [`performance_test`](https://gitlab.com/ApexAI/performance_test/-/tree/master/performance_test) | ||
|
||
### Workflow | ||
|
||
<!-- | ||
NOTE: Add new entries sorted by issue number to minimize the possibility of | ||
conflicts when merging. | ||
--> | ||
|
||
* Add README | ||
* Set up boilerplate for open-source contributions | ||
|