Skip to content

Commit b844a37

Browse files
committed
Update pull request template to suggest making PRs editable by maintainers
Often there are small "nitpicky" changes that need to be done to a PR in order to get it merged. To speed up the merge process, we will ask contributors if they are ok with the reviewer making those changes. Other fixups: Improve PR template rendering in browser's textarea field. Line wrapping at 80 characters provides a bad user experience within the browser, which handles word wrapping separately. Thus, prefer long lines in this markdown file. Remove the "backwards compatibility section". While the contributor should ideally care about the impact of their patch on the server's backwards compatibility, this is an advanced topic that is better presented in a separate document.
1 parent ada3987 commit b844a37

File tree

1 file changed

+19
-33
lines changed

1 file changed

+19
-33
lines changed

.github/pull_request_template.md

Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,47 @@
11
<!--
22
Thank you for contributing to the MariaDB Server repository!
33
4-
You can help us review your changes faster by filling this template <3
4+
You can help us review your changes faster by filling in this template <3
55
6-
If you have any questions related to MariaDB or you just want to
7-
hang out and meet other community members, please join us on
8-
https://mariadb.zulipchat.com/ .
6+
If you have any questions related to MariaDB or you just want to hang out and meet other community members, please join us on https://mariadb.zulipchat.com/ .
97
-->
108

119
<!--
12-
If you've already identified a https://jira.mariadb.org/ issue
13-
that seems to track this bug/feature, please add its number below.
10+
If you've already identified a https://jira.mariadb.org/ issue that seems to track this bug/feature, please add its number below.
1411
-->
15-
- [x] *The Jira issue number for this PR is: MDEV-_____*
12+
- [x] *The Jira issue number for this PR is: MDEV-______*
1613

1714
<!--
1815
An amazing description should answer some questions like:
1916
1. What problem is the patch trying to solve?
20-
2. If some output changed, what was it looking like before
21-
the change and how it's looking with this patch applied
22-
3. Do you think this patch might introduce side-effects in
23-
other parts of the server?
17+
2. If some output changed that is not visible in a test case, what was it looking like before the change and how it's looking with this patch applied?
18+
3. Do you think this patch might introduce side-effects in other parts of the server?
2419
-->
2520
## Description
2621
TODO: fill description here
2722

2823
## How can this PR be tested?
2924

30-
TODO: modify the automated test suite to verify that the PR causes MariaDB to
31-
behave as intended. Consult the documentation on
32-
["Writing good test cases"](https://mariadb.org/get-involved/getting-started-for-developers/writing-good-test-cases-mariadb-server).
33-
In many cases, this will be as simple as modifying one `.test` and one `.result`
34-
file in the `mysql-test/` subdirectory. Without _automated_ tests, future regressions
35-
in the expected behavior can't be automatically detected and verified.
25+
TODO: modify the automated test suite to verify that the PR causes MariaDB to behave as intended.
26+
Consult the documentation on ["Writing good test cases"](https://mariadb.org/get-involved/getting-started-for-developers/writing-good-test-cases-mariadb-server).
27+
<!--
28+
In many cases, this will be as simple as modifying one `.test` and one `.result` file in the `mysql-test/` subdirectory.
29+
Without automated tests, future regressions in the expected behavior can't be automatically detected and verified.
30+
-->
3631

37-
If the changes are not amenable to automated testing, please explain why not and
38-
carefully describe how to test manually.
32+
If the changes are not amenable to automated testing, please explain why not and carefully describe how to test manually.
3933

4034
<!--
41-
Tick one of the following boxes [x] to help us understand
42-
if the base branch for the PR is correct
43-
(Currently the earliest maintained branch is 10.3)
35+
Tick one of the following boxes [x] to help us understand if the base branch for the PR is correct. (Currently the earliest maintained branch is 10.3)
4436
-->
4537
## Basing the PR against the correct MariaDB version
46-
- [ ] *This is a new feature and the PR is based against the latest MariaDB development branch*
47-
- [ ] *This is a bug fix and the PR is based against the earliest maintained branch in which the bug can be reproduced*
38+
- [ ] *This is a new feature and the PR is based against the latest MariaDB development branch.*
39+
- [ ] *This is a bug fix and the PR is based against the earliest maintained branch in which the bug can be reproduced.*
4840

4941
<!--
50-
You might consider answering some questions like:
51-
1. Does this affect the on-disk format used by MariaDB?
52-
2. Does this change any behavior experienced by a user
53-
who upgrades from a version prior to this patch?
54-
3. Would a user be able to start MariaDB on a datadir
55-
created prior to your fix?
42+
All code merged into the MariaDB codebase must meet a quality standard and codying style.
43+
Maintainers are happy to point out inconsistencies but in order to speed up the review and merge process we ask you to check the CODING standards.
5644
-->
57-
## Backward compatibility
58-
TODO: fill details here, if applicable, or remove the section
59-
6045
## PR quality check
6146
- [ ] I checked the [CODING_STANDARDS.md](https://github.com/MariaDB/server/blob/11.0/CODING_STANDARDS.md) file and my PR conforms to this where appropriate.
47+
- [ ] For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.

0 commit comments

Comments
 (0)