mirror/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2025-01-16 03:52:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
mariadb/.github/pull_request_template.md

48 lines
2.5 KiB
Markdown
Raw Normal View History

Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
<!--
Thank you for contributing to the MariaDB Server repository!
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.
2023-03-28 08:01:23 +02:00
You can help us review your changes faster by filling in this template <3
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
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.
2023-03-28 08:01:23 +02:00
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/ .
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
-->
<!--
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.
2023-03-28 08:01:23 +02:00
If you've already identified a https://jira.mariadb.org/ issue that seems to track this bug/feature, please add its number below.
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
-->
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.
2023-03-28 08:01:23 +02:00
- [x] *The Jira issue number for this PR is: MDEV-______*
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
<!--
An amazing description should answer some questions like:
1. What problem is the patch trying to solve?
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.
2023-03-28 08:01:23 +02:00
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?
3. Do you think this patch might introduce side-effects in other parts of the server?
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
-->
## Description
TODO: fill description here
## How can this PR be tested?
Modify PR template to encourage contribution of automated tests 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.
2021-11-01 23:21:33 +01:00
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.
2023-03-28 08:01:23 +02:00
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.
-->
Modify PR template to encourage contribution of automated tests 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.
2021-11-01 23:21:33 +01:00
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.
2023-03-28 08:01:23 +02:00
If the changes are not amenable to automated testing, please explain why not and carefully describe how to test manually.
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
<!--
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.
2023-03-28 08:01:23 +02:00
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)
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
-->
## Basing the PR against the correct MariaDB version
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.
2023-03-28 08:01:23 +02:00
- [ ] *This is a new feature and the PR is based against the latest MariaDB development branch.*
- [ ] *This is a bug fix and the PR is based against the earliest maintained branch in which the bug can be reproduced.*
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
<!--
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.
2023-03-28 08:01:23 +02:00
All code merged into the MariaDB codebase must meet a quality standard and codying style.
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.
Add Pull Request template file to the MariaDB/server repository
2021-03-11 17:17:06 +01:00
-->
Add CODING_STANDARDS.md file This is intended to be the start of a (not complete) coding standards document we can refer contributors to. This can be modified to add more nuances and become stricter over time. It can also have additional content for other file types (CMake, YACC, etc). It does not cover plugins which should each individually have their own coding standards.
2022-09-19 16:30:09 +02:00
## PR quality check
Fix CODING_STANDARDS link in PR template Relative links do not work in pull request templates, so use an explicit link instead.
2023-02-22 11:32:17 +01:00
- [ ] 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.
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.
2023-03-28 08:01:23 +02:00
- [ ] For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.
Reference in a new issue Copy permalink