Skip to content

Add link to PR template also if checklist is present, but not OK#14694

Merged
koppor merged 1 commit into
mainfrom
koppor-patch-1
Dec 23, 2025
Merged

Add link to PR template also if checklist is present, but not OK#14694
koppor merged 1 commit into
mainfrom
koppor-patch-1

Conversation

@koppor

@koppor koppor commented Dec 23, 2025 •
edited by qodo-code-review Bot
Loading

Copy link
Copy Markdown
Member

User description

Triggered by #14668

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

PR Type

Enhancement

Description

  • Add PR template link to checklist validation message

  • Update PR template link to remove anchor reference

  • Ensure users see template guidance even when checklist incomplete

Diagram Walkthrough

flowchart LR
  A["PR Checklist Validation"] -->|"Missing Checks"| B["Show Template Link"]
  A -->|"Incomplete Checks"| C["Add Template Guidance"]
  B --> D["User Sees Template"]
  C --> D
Loading

File Walkthrough
Relevant files
Enhancement
ghprcomment.yml
Add template link to checklist validation messages             

.github/ghprcomment.yml

  • Updated message for "Mandatory Checks present" job to split text
    across lines for better readability
  • Modified PR template link by removing the anchor reference (#L10) to
    point to the full template page
  • Added PR template link guidance to "PR checklist OK" job message to
    ensure users see template reference even when checklist is incomplete
 +3/-1     

@koppor koppor requested a review from subhramit December 23, 2025 09:20
@qodo-code-review

qodo-code-review Bot commented Dec 23, 2025

Copy link
Copy Markdown
Contributor

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
⚪
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review

qodo-code-review Bot commented Dec 23, 2025

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix message formatting for readability

Add a blank line within the message block for the PR checklist OK job to
separate the two sentences into distinct paragraphs, improving readability.

.github/ghprcomment.yml [194-199]

 - jobName: 'PR checklist OK'
   workflowName: 'Check PR Format'
   always: true
   message: >
     Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of `[x]` (done), `[ ]` (not done yet) or `[/]` (not applicable).
+
     Please adhere to our [pull request template](https://github.com/JabRef/jabref/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1).
  • Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly points out that using a folded block scalar (>) will merge the lines, and adding a blank line will create a new paragraph, improving the comment's readability.

Low
  • More

@koppor koppor merged commit 9cf21de into main Dec 23, 2025
72 of 81 checks passed
@koppor koppor deleted the koppor-patch-1 branch December 23, 2025 11:50
Siedlerchr added a commit that referenced this pull request Dec 23, 2025
@Siedlerchr
Merge branch 'main' into improveCleanup
9a79580 
* main:
  Update AI usage policy (#14698)
  Fix handling of DOIs (#14704)
  Handle ohter CrossRef response (#14696)
  Fix condition for processing closed issues/PRs
  Translate the English "change to Chinese(simplified)" to the Chinese in the warning dialog (#14690)
  More performance optimization (#14695)
  Add missing dot (and a link)
  Add link to PR template also if checklist is present, but not OK (#14694)
  Fix typo in IntelliJ code style instructions (#14693)
  Add import into new library to Welcome Tab (#14669)
  Add initial search requirements (#14633)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@subhramit subhramit subhramit approved these changes

Assignees

No one assigned

Labels

Review effort 1/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@koppor @subhramit