mirror/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2025-01-15 19:42:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Modify PR template to encourage contribution of automated tests

Browse source 
Many recent PRs offer up shell scripts or example queries in the testing
section, when these could be easily and usefully be converted to automated
tests based on MTR.  (https://github.com/MariaDB/server/pull/1888 and
https://github.com/MariaDB/server/pull/1940 are good examples of this.)

This modifies the PR template to more strongly encourage the contribution of
automated tests.
This commit is contained in:
Daniel Lenski 2021-11-01 15:21:33 -07:00 committed by Robert Bindar
parent 5566cbadb0
commit e36a257323
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
.github/pull_request_template.md vendored
View file

@ -26,8 +26,16 @@ An amazing description should answer some questions like:
TODO: fill description here
## How can this PR be tested?
TODO: fill steps to reproduce here, if applicable,
or remove the section
TODO: modify the automated test suite to verify that the PR causes MariaDB to
behave as intended. Consult the documentation on
["Writing good test cases"](https://mariadb.org/get-involved/getting-started-for-developers/writing-good-test-cases-mariadb-server).
In many cases, this will be as simple as modifying one `.test` and one `.result`
file in the `mysql-test/` subdirectory. Without _automated_ tests, future regressions
in the expected behavior can't be automatically detected and verified.
If the changes are not amenable to automated testing, please explain why not and
carefully describe how to test manually.
<!--
Tick one of the following boxes [x] to help us understand
@ -47,4 +55,3 @@ You might consider answering some questions like:
-->
## Backward compatibility
TODO: fill details here, if applicable, or remove the section