Skip to content

Refine PR Template#13316

Merged
koppor merged 6 commits intomainfrom
koppor-patch-3
Jun 15, 2025
Merged

Refine PR Template#13316
koppor merged 6 commits intomainfrom
koppor-patch-3

Conversation

@koppor
Copy link
Copy Markdown
Member

@koppor koppor commented Jun 13, 2025

Trying to use backticks as markers for replacement. I think, <!-- -->, {{...}}, «...» will cause more confusion.

Rendering if nothing is changed

grafik

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [/] Tests created for changes (if applicable)
  • [/] Manually tested changed features in running JabRef (always required)
  • [/] Screenshots added in PR description (if change is visible to the user)
  • [/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • [/] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor requested a review from subhramit June 13, 2025 08:09
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
<!-- (Replace this paragraph.) -->

<!-- YOU HAVE TO MODIFY THE ABOVE TEXT FIT YOUR PR. OTHERWISE, YOUR PR WILL BE CLOSED WITHOUT FURTHER COMMENT. -->
<!-- LINK THE ISSUE WITH THE "Closes" KEYWORD. Example: Closes (link) OR Closes #12345 -->
Copy link
Copy Markdown
Member

@subhramit subhramit Jun 13, 2025

Choose a reason for hiding this comment

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

One last - I think we can move this line (14) above line 1

Copy link
Copy Markdown
Member

@subhramit subhramit Jun 13, 2025

Choose a reason for hiding this comment

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

Wait, was there any reason why we shifted this here? Some contributor messing up?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Claim: GitHub App on android shows exactly the first characters:

image

Did you get a notificatoin for https://github.com/JabRef/jabref-issue-melting-pot/pull/960 and can check?

I did not find any "strange" notification; but I think, I read all of them.

(We updated it at #13188)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I was done with GitHub app recently when I realized it ate away context from a link (e.g. someone wanted to point out to a comment or review, and it would just open the PR or issue)

I will install and try

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So are we shifting line 14?

Copy link
Copy Markdown
Member

@subhramit subhramit Jun 15, 2025

Choose a reason for hiding this comment

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

So are we shifting line 14?

Maybe to line 2 instead of 1? So that it is near the "Closes _____" and if it displays the first 3 characters that won't affect as well

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I shifted. See if this is fine (b3455d3)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I will reshift as soon as I have a screenshot (I hope there will be never one)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I shifted to line 2, not line 1, so the first 3 characters would still be "Clo" (if we are talking about the same thing) - so you should not face issues because of the comment at least

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
@subhramit
Copy link
Copy Markdown
Member

Ah the order of comments got messed up, sorry

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
@subhramit
Copy link
Copy Markdown
Member

Okay, I don't think we can make it better than this

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
@subhramit subhramit changed the title Better placeholders for PR template Refine PR Template Jun 13, 2025
koppor and others added 3 commits June 15, 2025 21:04
subhramit
subhramit previously approved these changes Jun 15, 2025
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
@koppor koppor merged commit c51a916 into main Jun 15, 2025
2 checks passed
@koppor koppor deleted the koppor-patch-3 branch June 15, 2025 21:44
@trag-bot
Copy link
Copy Markdown

trag-bot Bot commented Jun 15, 2025

@trag-bot didn't find any issues in the code! ✅✨

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