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

chore: update pull request template #91

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

34 changes: 0 additions & 34 deletions .github/PULL_REQUEST_TEMPLATE/small-change.md

This file was deleted.

42 changes: 0 additions & 42 deletions .github/PULL_REQUEST_TEMPLATE/standard-change.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## Description

## Related links

**Parent Issue:**

- Link

<!-- ⬇️🟢
**Private Links:**

- [CompanyName internal link]()
⬆️🟢 -->

## How was this PR tested?

## Notes for reviewers

None.

## Interface changes

None.

<!-- ⬇️🔴

### Topic changes

#### Additions and removals

| Change type | Topic Type | Topic Name | Message Type | Description |
|:--------------|:----------------|:--------------|:--------------------|:------------------|
| Added/Removed | Pub/Sub/Srv/Cli | `/topic_name` | `std_msgs/String` | Topic description |

#### Modifications

| Version | Topic Type | Topic Name | Message Type | Description |
|:--------|:----------------|:------------------|:--------------------|:------------------|
| Old | Pub/Sub/Srv/Cli | `/old_topic_name` | `sensor_msgs/Image` | Topic description |
| New | Pub/Sub/Srv/Cli | `/new_topic_name` | `sensor_msgs/Image` | Topic description |

### ROS Parameter Changes

#### Additions and removals

| Change type | Parameter Name | Type | Default Value | Description |
|:--------------|:---------------|:---------|:--------------|:------------------|
| Added/Removed | `param_name` | `double` | `1.0` | Param description |

#### Modifications

| Version | Parameter Name | Type | Default Value | Description |
|:--------|:-----------------|:---------|:--------------|:------------------|
| Old | `old_param_name` | `double` | `1.0` | Param description |
| New | `new_param_name` | `double` | `1.0` | Param description |

🔴⬆️ -->

## Effects on system behavior

None.
25 changes: 25 additions & 0 deletions .github/workflows/comment-on-pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: comment-on-pr
on:
pull_request_target:

jobs:
comment-on-pr:
runs-on: ubuntu-22.04
permissions:
pull-requests: write
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Initial PR comment
uses: marocchino/sticky-pull-request-comment@v2
with:
message: |
Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, [switch it to draft mode](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).

Please ensure:
- You've checked our [contribution guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/).
- Your PR follows our [pull request guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/pull-request-guidelines/).
- All required CI checks pass before [marking the PR ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review).
Loading