Skip to content

Refine PULL_REQUEST_TEMPLATE.md#13304

Merged
koppor merged 2 commits intomainfrom
koppor-patch-2
Jun 11, 2025
Merged

Refine PULL_REQUEST_TEMPLATE.md#13304
koppor merged 2 commits intomainfrom
koppor-patch-2

Conversation

@koppor
Copy link
Copy Markdown
Member

@koppor koppor commented Jun 11, 2025

Minor tweak to make it clear what unchecked TODO boxes mean in our context.

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 11, 2025 06:29
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
@calixtus
Copy link
Copy Markdown
Member

im still not so happy with unchecking by putting sthg into the boxes. Github does not understand them. If they are empty, you can click on them in github ui to check/uncheck them. If you put sthg inside but an x, you cannot click them anymore...

@koppor
Copy link
Copy Markdown
Member Author

koppor commented Jun 11, 2025

im still not so happy with unchecking by putting sthg into the boxes. Github does not understand them. If they are empty, you can click on them in github ui to check/uncheck them. If you put sthg inside but an x, you cannot click them anymore...

Exactly as intended. The / denotes not-applicable.

If we say to a contributor: Please do it, we cannot simply uncheck a box, we need to tell him in other ways.

For me, it helps that a checked box means "done" in the sense of a change of the global JabRef state (code changed, documentation changed, issue created) - and not "done or invalid or not-done, but thought of",

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
@subhramit
Copy link
Copy Markdown
Member

subhramit commented Jun 11, 2025

im still not so happy with unchecking by putting sthg into the boxes. Github does not understand them. If they are empty, you can click on them in github ui to check/uncheck them. If you put sthg inside but an x, you cannot click them anymore...

Our thought process during the decision:
We did that to differentiate if people have read the section or not. When writing the initial description from the template, the contributor uses the keyboard instead of mouse - so they are to remove the dot inside [.] and choose as applicable.

Ideally, the boxes should contain only [ ] or [x]. Only disagreement may be in case of not applicable - whether it should be a [/] or a strikethrough (although that may be a bit extra instruction for the contributor). Both are not recognized by github markdown as valid clickable checkboxes.
GitHub counts the number of "applicable" tasks done that way as well:

image

Do you propose anything different?

@trag-bot
Copy link
Copy Markdown

trag-bot Bot commented Jun 11, 2025

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

@calixtus
Copy link
Copy Markdown
Member

clueless too. @koppor has a valid point. we expect the contributors to read the text. And i would not want to have or maintain a cla like oracle.

@calixtus
Copy link
Copy Markdown
Member

lets not make this a problem now, maybe we see sthg better eventually and discuss it then.

@koppor koppor enabled auto-merge June 11, 2025 08:24
@koppor koppor merged commit 0d6969b into main Jun 11, 2025
2 checks passed
@koppor koppor deleted the koppor-patch-2 branch June 11, 2025 08:27
Siedlerchr added a commit to FlyJoanne/jabref that referenced this pull request Jun 15, 2025
* upstream/main:
  New Crowdin updates (JabRef#13330)
  Add arm 64 linux runner (JabRef#13258)
  Rename strings and variables in New Entry (JabRef#13312)
  Let consistency checker yield a return code (JabRef#13329)
  Update LETTER fragment to resolve Windows parsing issue (JabRef#13327)
  Add support for "dev: no-bot-comments"
  Update dependency org.hibernate.validator:hibernate-validator to v9.0.1.Final (JabRef#13322)
  Endnote XML Exporter: Move factory initialization to constructor (JabRef#13321)
  Refine assignment reminder (JabRef#13315)
  Add welcome message to first time contributors (JabRef#13314)
  New Crowdin updates (JabRef#13311)
  Added a setting to show File annotations' tab only when the PDF actually contains highlights or comments (JabRef#13279)
  Update dependency org.postgresql:postgresql to v42.7.7 (JabRef#13306)
  Refine PULL_REQUEST_TEMPLATE.md (JabRef#13304)
  Move module tweaking of merged module to launcher (JabRef#13303)
  Speed up gradle update (JabRef#13300)
  testImplementation is enough (JabRef#13299)
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.

3 participants