Skip to content

Refine pull request template for clarity and detail - #8

Merged
aeruhxi merged 2 commits into
mainfrom
aeruhxi-patch-1
Oct 15, 2026
Merged

aeruhxi merged 2 commits into
mainfrom
aeruhxi-patch-1

Conversation

@aeruhxi

@aeruhxi aeruhxi commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Description:

Aligns the shared PR template with https://github.com/Kittl/mono/pull/15939

How to test:

  • After merge, open a PR in a Kittl repo without its own template and check that the new sections show up.

Checklist (based on PR guidelines):

  • I have self-reviewed this PR, according to these points
  • This PR falls into maximum three of these categories
  • I feel comfortable taking responsibility for merging this code to production
  • The code is high quality, well-tested, follows styles guides (Frontend), clean, and well documented

Updated the pull request template to clarify sections on description, changes included, and testing instructions.
Comment thread .github/pull_request_template.md Outdated
**How to test:**

- Add instructions on how to run here
- Steps to reproduce the issue and what happens now, or where to find the feature (preview link, page, flag, required plan or data) and what to expect. Do not list lint, type checks, or tests; CI runs them

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not everything is an issue, would phrase it more general.
I wouldn't put a hard restriction to exclude tests, some PR are best "tested" by running a certain test before and after and see the difference from that

@aeruhxi aeruhxi Oct 14, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

not everything is an issue, would phrase it more general.

I agree

I wouldn't put a hard restriction to exclude tests, some PR are best "tested" by running a certain test before and after and see the difference from that

I do not understand this. Tests are already adjusted to pass if your PR is ready for review. Or, do you mean adjusting the runtime logic while preserving the newer tests and intentionally failing the test so we can verify that the test is catching bugs? If so, then I am in agreement.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah. Whether a test is passing is checked by CI. but for some PRs the best way to test them is to run a specific test under different parameters or just see how test timing is changing. I don't think this is a super recurring case, I would just avoid to put a hard limit on it

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated both PRs in regards to hard limiting the inclusion of test.

Updated the testing instructions for clarity on how to test changes.
@aeruhxi
aeruhxi requested a review from claas-c October 15, 2026 11:04
@aeruhxi
aeruhxi merged commit 4a6deba into main Oct 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants