Skip to content

Add screenshot requirement#15050

Merged
koppor merged 3 commits intomainfrom
koppor-patch-2
Feb 7, 2026
Merged

Add screenshot requirement#15050
koppor merged 3 commits intomainfrom
koppor-patch-2

Conversation

@koppor
Copy link
Copy Markdown
Member

@koppor koppor commented Feb 7, 2026

No description provided.

@qodo-free-for-open-source-projects
Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Add specific screenshot requirement to PR template

📝 Documentation

Grey Divider

Walkthroughs

Description
• Add specific screenshot requirement to PR template
• Require screenshot showing library with single entry
• Entry must have submitter as author and issue number as title
Diagram
flowchart LR
  A["PR Template"] -- "Add screenshot requirement" --> B["Library entry screenshot"]
  B -- "Author: submitter" --> C["Issue number as title"]
Loading

Grey Divider

File Changes

1. .github/PULL_REQUEST_TEMPLATE.md 📝 Documentation +1/-0

Add detailed screenshot requirement to checklist

• Added new checkbox item requiring screenshot of library with single entry
• Screenshot must show entry with submitter as author and issue number as title
• Clarifies existing screenshot requirement with specific example format

.github/PULL_REQUEST_TEMPLATE.md


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects
Copy link
Copy Markdown
Contributor

qodo-free-for-open-source-projects Bot commented Feb 7, 2026

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (1) 📎 Requirement gaps (0)

Grey Divider


Action required

✅ 1. CI checkbox count mismatch 🐞 Bug ⛯ Reliability
Description
• The PR template now contains 7 checkbox lines under “### Mandatory checks”.
• The “Check PR Format” workflow enforces an exact checkbox-line count of 6, so PRs using the
  updated template will fail CI even if the author follows the template.
• This creates a contribution blocker (false-negative) and will require manual intervention or
  template rollback.
Code

.github/PULL_REQUEST_TEMPLATE.md[41]

+- [.] I added a screenshot in the PR description showing library with a single entry with me as author and as title the issue number.
Evidence
The PR template adds one more checklist line, but the workflow validation still hard-codes a
requirement of exactly 6 checkbox lines in the “Mandatory checks” section. Therefore, the newly
added line will cause the workflow to exit with failure when run against PR bodies following the
updated template.

.github/PULL_REQUEST_TEMPLATE.md[37-43]
.github/workflows/pr-format.yml[117-132]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The PR template adds a new mandatory checkbox line, but the GitHub Actions workflow `.github/workflows/pr-format.yml` still requires exactly 6 checkbox lines under `### Mandatory checks`. This will fail CI for otherwise-correct PRs.
### Issue Context
The workflow extracts checkbox lines (`grep "^- \["`) and enforces `LINE_COUNT != 6` as an error. The template now includes 7 checkbox lines.
### Fix Focus Areas
- .github/workflows/pr-format.yml[117-132]
- .github/PULL_REQUEST_TEMPLATE.md[37-43]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

✅ 2. Unclear screenshot checklist text 📘 Rule violation ✓ Correctness
Description
• The newly added checklist item contains awkward/incorrect grammar (e.g., missing article in
  showing library and unclear phrasing with me as author and as title the issue number).
• This reduces professionalism and can confuse contributors about the exact screenshot requirement.
• The template should be revised to a clear, grammatically correct instruction to meet documentation
  quality expectations.
Code

.github/PULL_REQUEST_TEMPLATE.md[41]

+- [.] I added a screenshot in the PR description showing library with a single entry with me as author and as title the issue number.
Evidence
PR Compliance ID 41 requires updated documentation/user-facing text to be free of obvious
typographical and grammatical errors. The added PR template line is user-facing guidance and
contains grammatically incorrect/unclear phrasing.

.github/PULL_REQUEST_TEMPLATE.md[41-41]
Best Practice: Learned patterns

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The added PR template checklist item is grammatically incorrect/unclear, which can confuse contributors and violates the requirement to avoid typos/grammar errors in documentation/user-facing text.
## Issue Context
This is a user-facing instruction in `.github/PULL_REQUEST_TEMPLATE.md`, so clarity and correctness matter.
## Fix Focus Areas
- .github/PULL_REQUEST_TEMPLATE.md[41-41]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
- [.] 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 added a screenshot in the PR description showing library with a single entry with me as author and as title the issue number.
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.

Action required

1. Ci checkbox count mismatch 🐞 Bug ⛯ Reliability

• The PR template now contains 7 checkbox lines under “### Mandatory checks”.
• The “Check PR Format” workflow enforces an exact checkbox-line count of 6, so PRs using the
  updated template will fail CI even if the author follows the template.
• This creates a contribution blocker (false-negative) and will require manual intervention or
  template rollback.
Agent Prompt
### Issue description
The PR template adds a new mandatory checkbox line, but the GitHub Actions workflow `.github/workflows/pr-format.yml` still requires exactly 6 checkbox lines under `### Mandatory checks`. This will fail CI for otherwise-correct PRs.

### Issue Context
The workflow extracts checkbox lines (`grep "^- \["`) and enforces `LINE_COUNT != 6` as an error. The template now includes 7 checkbox lines.

### Fix Focus Areas
- .github/workflows/pr-format.yml[117-132]
- .github/PULL_REQUEST_TEMPLATE.md[37-43]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

@testlens-app
Copy link
Copy Markdown

testlens-app Bot commented Feb 7, 2026

✅ All tests passed ✅

🏷️ Commit: c64283e
▶️ Tests: 11185 executed
⚪️ Checks: 53/53 completed


Learn more about TestLens at testlens.app.

@koppor koppor merged commit aa45955 into main Feb 7, 2026
54 checks passed
@koppor koppor deleted the koppor-patch-2 branch February 7, 2026 16:20
Siedlerchr added a commit that referenced this pull request Feb 8, 2026
…es/jablib/src/main/resources/csl-styles-6c79ffe

* upstream/main: (68 commits)
  Chore(deps): Bump org.apache.httpcomponents.client5:httpclient5 (#15060)
  Chore(deps): Bump com.google.errorprone:error_prone_core in /versions (#15059)
  Chore(deps): Bump de.undercouch.download:de.undercouch.download.gradle.plugin (#15057)
  Chore(deps): Bump org.postgresql:postgresql in /versions (#15058)
  Chore(deps): Bump de.undercouch.download:de.undercouch.download.gradle.plugin (#15056)
  Updates on Wednesday, not on Sunday
  Add screenshot requirement (#15050)
  Switch image for javadoc
  Better docker layer caching during build (#15042)
  New Crowdin updates (#15045)
  Chore: reuse shared 'setup-gradle' in all places in test-code.yml (#15043)
  Chore: add 'testlens-app/setup-testlens' GH action (#15044)
  Add: HTTP Server and LSP server toggles to quick settings (#14972)
  Some more recipes from OpenRewrite (#15030)
  feat: Add PDF Upload endpoint to EntryResource (#14963)
  Heuristics also used at batch (#15025)
  Fix cleanup-pr.yml
  New Crowdin updates (#15035)
  Use patched Gradle version (#15034)
  Add OpenAlex-based Citation Fetcher (#15023)
  ...
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