diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f8efdbd7f8e..87da2294fe4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,26 +1,60 @@ -Make sure you have checked _all_ steps below. + + +## What is the purpose of the change + +*(For example: This pull request improves file read performance by buffering data, fixing AVRO-XXXX.)* + + +## Verifying this change + +*(Please pick one of the following options)* + +This change is a trivial rework / code cleanup without any test coverage. + +*(or)* + +This change is already covered by existing tests, such as *(please describe tests)*. + +*(or)* + +This change added tests and can be verified as follows: + +*(example:)* +- *Extended interop tests to verify consistent valid schema names between SDKs* +- *Added test that validates that Java throws an AvroRuntimeException on invalid binary data* +- *Manually verified the change by building the website and checking the new redirect* + + +## Documentation + +- Does this pull request introduce a new feature? (yes / no) +- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)