Skip to content

Commit ef3cef1

Browse files
authoredJun 24, 2024
chore: update the PR template (#7667)
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
1 parent dcb8803 commit ef3cef1

File tree

6 files changed

+86
-118
lines changed

6 files changed

+86
-118
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

-8
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/small-change.md

-44
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/standard-change.md

-63
This file was deleted.

‎.github/pull_request_template.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Description
2+
3+
## Related links
4+
5+
**Parent Issue:**
6+
7+
- Link
8+
9+
<!-- ⬇️🟢
10+
**Private Links:**
11+
12+
- [CompanyName internal link]()
13+
⬆️🟢 -->
14+
15+
## How was this PR tested?
16+
17+
## Notes for reviewers
18+
19+
None.
20+
21+
## Interface changes
22+
23+
None.
24+
25+
<!-- ⬇️🔴
26+
27+
### Topic changes
28+
29+
#### Additions and removals
30+
31+
| Change type | Topic Type | Topic Name | Message Type | Description |
32+
|:--------------|:----------------|:--------------|:--------------------|:------------------|
33+
| Added/Removed | Pub/Sub/Srv/Cli | `/topic_name` | `std_msgs/String` | Topic description |
34+
35+
#### Modifications
36+
37+
| Version | Topic Type | Topic Name | Message Type | Description |
38+
|:--------|:----------------|:------------------|:--------------------|:------------------|
39+
| Old | Pub/Sub/Srv/Cli | `/old_topic_name` | `sensor_msgs/Image` | Topic description |
40+
| New | Pub/Sub/Srv/Cli | `/new_topic_name` | `sensor_msgs/Image` | Topic description |
41+
42+
### ROS Parameter Changes
43+
44+
#### Additions and removals
45+
46+
| Change type | Parameter Name | Type | Default Value | Description |
47+
|:--------------|:---------------|:---------|:--------------|:------------------|
48+
| Added/Removed | `param_name` | `double` | `1.0` | Param description |
49+
50+
#### Modifications
51+
52+
| Version | Parameter Name | Type | Default Value | Description |
53+
|:--------|:-----------------|:---------|:--------------|:------------------|
54+
| Old | `old_param_name` | `double` | `1.0` | Param description |
55+
| New | `new_param_name` | `double` | `1.0` | Param description |
56+
57+
🔴⬆️ -->
58+
59+
## Effects on system behavior
60+
61+
None.

‎.github/sync-files.yaml

-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
- source: .github/ISSUE_TEMPLATE/bug.yaml
88
- source: .github/ISSUE_TEMPLATE/config.yml
99
- source: .github/ISSUE_TEMPLATE/task.yaml
10-
- source: .github/PULL_REQUEST_TEMPLATE.md
11-
- source: .github/PULL_REQUEST_TEMPLATE/small-change.md
12-
- source: .github/PULL_REQUEST_TEMPLATE/standard-change.md
1310
- source: .github/dependabot.yaml
1411
- source: .github/stale.yml
1512
- source: .github/workflows/cancel-previous-workflows.yaml

‎.github/workflows/comment_on_pr.yaml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Comment on PR
2+
on:
3+
pull_request:
4+
5+
jobs:
6+
comment-on-pr:
7+
runs-on: ubuntu-latest
8+
permissions:
9+
pull-requests: write
10+
steps:
11+
- name: Check out repository
12+
uses: actions/checkout@v4
13+
14+
- name: Initial PR comment
15+
uses: marocchino/sticky-pull-request-comment@v2
16+
with:
17+
message: |
18+
Thank you for contributing to the Autoware project!
19+
20+
🚧 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).
21+
22+
Please ensure:
23+
- You've checked our [contribution guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/).
24+
- Your PR follows our [pull request guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/pull-request-guidelines/).
25+
- 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).

0 commit comments

Comments
 (0)