👷 Added PR checklist workflow

[devtobi]

Pull Request

Changes

• Added pr-checklist workflow linking to lhm_action

Reference

Issue: #803

Checklist

Note: If some checklist items are not relevant for your PR, just remove them.

General

• I have read the Contribution Guidelines (TBD)
• Met all acceptance criteria of the issue
• Added meaningful PR title and list of changes in the description
• Created / Updated documentation (in English)
• Opened follow-up issue in refarch repository (if applicable)

Summary by CodeRabbit

• Chores
  • Introduced an automated workflow that validates pull request checklist items on key PR events.
• Documentation
  • Added a section on "Require PR checklist" outlining the workflow for checklist validation in pull requests.
  • Updated developer guides to detail the new checklist process integrated with pull request templates, including instructions for adjustments and disabling when necessary.

[coderabbitai]

Walkthrough

A new GitHub Actions workflow (pr-checklist.yml) has been added to enforce a pull request checklist. The workflow triggers on PR events (opened, edited, reopened, synchronized, or marked ready for review) and runs on Ubuntu using a fixed version of an action from the it-at-m/lhm_actions/action-templates repository. Documentation updates in docs/develop.md and docs/organize.md provide details on the checklist requirement, explain its integration with PR templates, and offer guidance on disabling the feature if needed.

Changes

File(s)	Change Summary
.github/workflows/pr-checklist.yml	Introduces a GitHub Actions workflow that triggers on various PR events and runs a job to enforce a PR checklist using a specific commit of an external action.
docs/develop.md, docs/organize.md	Adds documentation for the "Require PR checklist" feature: a new section in develop.md details checklist enforcement, while organize.md includes an integration note linking PR templates with the checklist mechanism.

Possibly related PRs

• Feat/18 pull request template #804: Introduces a pull request template with a checklist that standardizes the PR process, closely aligning with the enforcement workflow introduced here.
• Changing reference of actions from .github to lhm_actions repo #776: Updates action references in various workflows, related to the modifications in the new PR checklist workflow.
• chore(deps): update it-at-m/lhm_actions action to v1.0.1 #823: Updates the version of the it-at-m/lhm_actions action, which includes bug fixes relevant to pull request checklist actions.

Suggested reviewers

• simonhir

Poem

Hop along in code so neat,
A checklist dance with every beat.
PRs open, a workflow in flight,
Validating steps, oh what a sight!
From carrot tips to code so bright,
We rabbit-proof our code tonight! 🐰🚀

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5725d71 and d35ee80.

📒 Files selected for processing (3)

• .github/workflows/pr-checklist.yml (1 hunks)
• docs/develop.md (1 hunks)
• docs/organize.md (1 hunks)

🧰 Additional context used

🪛 YAMLlint (1.35.1)

.github/workflows/pr-checklist.yml

[warning] 3-3: truthy value should be one of [false, true]

(truthy)

---

[error] 11-11: no new line character at the end of file

(new-line-at-end-of-file)

🪛 LanguageTool

docs/develop.md

[style] ~217-~217: This phrase is redundant. Consider using “inside”.
Context: ...for validating the status of checklists inside of a PR description. To be able to merge a...

(OUTSIDE_OF)

---

[uncategorized] ~217-~217: Possible missing comma found.
Context: ...a PR description. To be able to merge a PR all checklist items have to be ticked o...

(AI_HYDRA_LEO_MISSING_COMMA)

docs/organize.md

[style] ~55-~55: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...tml#require-pr-checklist) the templates are able to enforce a careful examination of each P...

(BE_ABLE_TO)

🔇 Additional comments (2)

.github/workflows/pr-checklist.yml (2)

1-2: Clear Workflow Name Declaration.
The workflow name "Require PR Checklist" clearly communicates its intent.

---

3-6: Well-Defined Trigger Events.
The specified pull request events (opened, edited, reopened, synchronize, ready_for_review) adequately cover the scenarios when the checklist validation is needed.

🧰 Tools

🪛 YAMLlint (1.35.1)

[warning] 3-3: truthy value should be one of [false, true]

(truthy)

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d35ee80 and 450cb92.

📒 Files selected for processing (2)

• docs/develop.md (1 hunks)
• docs/organize.md (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Deploy documentation website

docs/develop.md

[warning] 1-1: Code style issues found in the above file. Run Prettier with --write to fix.

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build (refarch-backend)

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 450cb92 and d86ca07.

📒 Files selected for processing (1)

• docs/develop.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build (refarch-backend)

🔇 Additional comments (1)

docs/develop.md (1)

219-220: Verify the PR Template Link
The section includes a link: “PR template”. Please confirm that the target reference is correct. If the documentation is written in Markdown, verify whether the link should use a “.md” extension rather than “.html” to ensure consistency and proper navigation.

[simonhir]

LGTM

[hupling]

lgtm