diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9045aeb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## Notes for Reviewer + + +## 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 + + + +Closes # + diff --git a/doc/release-notes/template.md b/doc/release-notes/template.md new file mode 100644 index 0000000..6f70781 --- /dev/null +++ b/doc/release-notes/template.md @@ -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 + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Bugfixes + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Refactoring + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Workflow + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### New API features + + + +* 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(); + ``` diff --git a/doc/release-notes/unreleased.md b/doc/release-notes/unreleased.md new file mode 100644 index 0000000..6f70781 --- /dev/null +++ b/doc/release-notes/unreleased.md @@ -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 + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Bugfixes + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Refactoring + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### Workflow + + + +* Example text [#1](https://github.com/ekxide/rmw_iceoryx2/issues/1) + +### New API features + + + +* 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(); + ``` diff --git a/doc/release-notes/v0.1.0.md b/doc/release-notes/v0.1.0.md new file mode 100644 index 0000000..b6484c0 --- /dev/null +++ b/doc/release-notes/v0.1.0.md @@ -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 + + + +* 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 + + + +* Add README +* Set up boilerplate for open-source contributions +