Skip to content

Update pull_request_template.md #4209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ParadoxV5 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update pull_request_template.md #4209

ParadoxV5 wants to merge 1 commit into from

Conversation

@ParadoxV5
Copy link
Contributor

@ParadoxV5 ParadoxV5 commented Jul 17, 2025 •
edited
Loading

  • The Jira issue number for this PR is: MDEV-37908

Description

  • Replace the KB link with a Docs link
    • This is the main motivation for these changes.
  • Improve the grammar and wording
    • Mainly so my grammar checker would stop complaining about basic-tier mistakes that I didn’t make.
  • Move the section comments below their section headings
    • They explicitly belong to their sections in this format.

Release Notes & How can this PR be tested?

N/A

Basing the PR against the correct MariaDB version

  • This is a new feature or a refactoring, and the PR is based on the main branch.
  • This is a bug fix, and the PR is based on the earliest maintained branch in which the bug can be reproduced.

PR quality check

  • I checked the CODING_STANDARDS.md file and my PR conforms to this where appropriate.
  • For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.

ParadoxV5
ParadoxV5 commented Jul 17, 2025
View reviewed changes
Copy link
Contributor Author

@ParadoxV5 ParadoxV5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For those wondering: Yes, CI is mandatory for non-code changes too now. MDBF-1058

.github/pull_request_template.md
- [ ] I checked the [CODING_STANDARDS.md](https://github.com/MariaDB/server/blob/-/CODING_STANDARDS.md) file and my PR conforms to this where appropriate.
- [ ] For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.
- [ ] I checked the [CODING_STANDARDS.md](https://github.com/MariaDB/server/blob/-/CODING_STANDARDS.md) file, and my PR conforms to this where appropriate.
- [ ] For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.
Copy link
Contributor Author

@ParadoxV5 ParadoxV5 Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow, the PR UI doesn’t strip the trailing ␊.
It’s standard for files, but looks odd in a multiline textbox.

.github/pull_request_template.md
List any https://mariadb.com/kb/ pages that need changing.
-->

## How to test this PR?
Copy link
Contributor Author

@ParadoxV5 ParadoxV5 Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Active Voice > Passive Voice

.github/pull_request_template.md Outdated
If you've already identified a https://jira.mariadb.org/ issue that tracks this bug/feature, please add its number below.
-->
- [x] *The Jira issue number for this PR is: MDEV-______*
- [x] *The Jira issue number for this PR is: [MDEV-_____](https://jira.mariadb.org/browse/MDEV-_____)*
Copy link
Contributor Author

@ParadoxV5 ParadoxV5 Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, we could use some custom autolinks, though that’s a paid feature.

@ParadoxV5
Update pull_request_template.md
e8e9771 
* Replace the KB link with a Docs link
* Improve the grammar and wording
* Move the section comments below their section headings
@ParadoxV5 ParadoxV5 force-pushed the px5.pull_request_template branch from 5a82ddd to e8e9771 Compare July 17, 2025 22:08
grooverdan
grooverdan approved these changes Jul 17, 2025
View reviewed changes
Copy link
Member

@grooverdan grooverdan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvements, thanks.

Unsure if the JIRA url thing is going to be confusing but doesn't hurt to try.

@svoj
Copy link
Contributor

svoj commented Jul 18, 2025

Frankly speaking I'd remove this template. People don't seem to bother following it in many cases. And it doesn't seem to bring us much value, at the cost of annoying those who create pull requests often. I'd rather have a link to PR guidelines and the let PR authors fill description in a free form.

@vuvova
Copy link
Member

vuvova commented Jul 18, 2025

I agree with @svoj , let's remove it

@ParadoxV5
Copy link
Contributor Author

ParadoxV5 commented Jul 18, 2025

Fine by me!

Though the “checklist” was sometimes helpful.
Let’s move them to https://mariadb.org/get-involved/getting-started-for-developers/submitting-pull-request/ or even CONTRIBUTING.md.

@gkodinov
Copy link
Contributor

gkodinov commented Dec 17, 2025

Please check (and hopefully review) #4487 about the removal of the file. If you find it appropriate please close this one in its favor.

@dr-m dr-m mentioned this pull request Dec 17, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@grooverdan grooverdan grooverdan approved these changes

Assignees

No one assigned

Labels

MariaDB Corporation

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ParadoxV5 @svoj @vuvova @gkodinov @grooverdan