Skip to content

CHECKLIST.md

Latest commit

 

History

History
42 lines (33 loc) · 2.83 KB

CHECKLIST.md

File metadata and controls

42 lines (33 loc) · 2.83 KB

Code checklist

This is the final quality check to run after the work is finished, before creating a PR. AGENTS.md gives guidance to follow while developing; this file is the gate that confirms the result. Go through every point and fix the code until all points are fulfilled. Do not skip any point.

Code rules

  • JSpecify annotations used instead of == null checks.
  • org.jabref.logic.util.strings.StringUtil.isBlank(java.lang.String) used instead of == null || ...isBlank().
  • No catch (Exception e) — only specific exceptions caught.
  • No commented-out code left behind.
  • User-facing text is localized (Localization.lang in Java, % prefix in FXML).
  • New BibEntry objects created with withers (withField, not setField).
  • User-controlled data (request params, entry fields, file contents) is HTML-escaped before being written into any text/html response — including exception/error messages, not just the success body (XSS).
  • Tests added or updated for changed behavior in org.jabref.model / org.jabref.logic.

Verification commands

  • ./gradlew :jablib:check (or ./gradlew check for all modules) passes.
  • ./gradlew checkstyleMain checkstyleTest checkstyleJmh passes.
  • ./gradlew modernizer passes.
  • ./gradlew --no-configuration-cache :rewriteDryRun reports no changes (run ./gradlew rewriteRun to fix).
  • ./gradlew javadoc passes.
  • npx markdownlint-cli2 "docs/**/*.md" "*.md" passes.
  • docker run -v $(pwd):/github/workspace ghcr.io/leventebajczi/intellij-format:master "*.java" "" ".idea/codeStyles/Project.xml" executed to ensure proper formatting.

Documentation

  • CHANGELOG.md entry added if the change is visible to the user (end-user wording, no extra blank lines). Use TODO as the issue/PR reference placeholder when no issue is known and the PR is not yet created — never a fake number.
  • Searched jabref/issues and jabref-koppor/issues for a related issue; linked only on a confident match, otherwise kept TODO (no closes/fixes for merely-similar issues).
  • Requirement added to docs/requirements/<area>.md if the change is a new feature or significant bug fix (skip for refactors, minor fixes, and internal changes).
  • Developer documentation under docs/ updated if behavior or architecture changed.

Pull request

  • PR body built from .github/PULL_REQUEST_TEMPLATE.md, every section filled.
  • All checklist items kept and marked [x], [ ], or [/].
  • All HTML comments removed from the PR body.
  • PR created with gh pr create --body-file <file> (not --body).
  • If CHANGELOG.md used a TODO placeholder, it was replaced with the real PR-number link after PR creation, then committed and pushed.