search

autowarefoundation / autoware

Autoware - the world's leading open-source software project for autonomous driving
https://www.autoware.org/
Apache License 2.0
8.58k stars 2.88k forks source link

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

Closed Owen-Liuyuxuan closed 2 months ago

Owen-Liuyuxuan commented 2 months ago

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.

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