diff --git a/docs/contributing/pull-request-guidelines/index.md b/docs/contributing/pull-request-guidelines/index.md index 670d7115b95..a38a3618535 100644 --- a/docs/contributing/pull-request-guidelines/index.md +++ b/docs/contributing/pull-request-guidelines/index.md @@ -50,6 +50,26 @@ Use this workflow as a reference when you contribute to Autoware. #### Example +There are two types of templates. Select one based on the following condition. + +1. [Standard change](https://github.com/autowarefoundation/autoware/blob/main/.github/PULL_REQUEST_TEMPLATE/standard-change.md): + - Complexity: + - New features or significant updates. + - Requires deeper understanding of the codebase. + - Impact: + - Affects multiple parts of the system. + - Basically includes minor features, bug fixes and performance improvement. + - Needs testing before merging. +2. [Small change](https://github.com/autowarefoundation/autoware/blob/main/.github/PULL_REQUEST_TEMPLATE/small-change.md): + - Complexity: + - Documentation, simple refactoring, or style adjustments. + - Easy to understand and review. + - Impact: + - Minimal effect on the system. + - Quicker merge with less testing needed. + +##### Steps to use an appropriate pull request template + 1. Select the appropriate template, as shown in [this video](https://user-images.githubusercontent.com/31987104/184344710-2adee239-799f-4fdf-bfab-be76345bfac1.mp4). 2. Read the selected template carefully and fill the required content. 3. Check the checkboxes during a review.