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

feat(pull_request_templates): improve the pull request template to enhance requirements on documenting interface changes #4654

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

Owen-Liuyuxuan
Copy link
Contributor

Description

Augment the pull request template to enhance requirements for documenting interface changes.

  1. Add the "Interface changes" section in small-change, because we witness many small changes including additional debugging topics and parameters that are not well-documented in current PRs.
  2. Add template tables for documenting changes in topics and parameters for standard change. We hope this could help code contributors create clean visualizations of the interface updates.

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Yuxuan Liu <uken.ryu.2@tier4.jp>
Signed-off-by: Yuxuan Liu <uken.ryu.2@tier4.jp>
@shmpwk shmpwk self-requested a review April 24, 2024 08:23
Copy link
Contributor

@shmpwk shmpwk left a comment

Choose a reason for hiding this comment

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

LGTM!

@shmpwk shmpwk merged commit 0cea511 into autowarefoundation:main Apr 24, 2024
13 checks passed
oguzkaganozt pushed a commit that referenced this pull request Apr 30, 2024
…hance requirements on documenting interface changes (#4654)

* improve template

Signed-off-by: Yuxuan Liu <uken.ryu.2@tier4.jp>

* fix typos

Signed-off-by: Yuxuan Liu <uken.ryu.2@tier4.jp>

---------

Signed-off-by: Yuxuan Liu <uken.ryu.2@tier4.jp>
Co-authored-by: Yuxuan Liu <uken.ryu.2@tier4.jp>
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.

3 participants