ci: force qodo to check PR desc

[JohnMcLear]

Force qodo to check PR desc

[qodo-free-for-open-source-projects]

Review Summary by Qodo

Add PR description requirement to best practices

📝 Documentation

Walkthroughs

Description

• Add PR description requirement to best practices
• Enforce non-empty descriptions for all pull requests
• Flag incomplete PRs without descriptions

Diagram

flowchart LR
  A["best_practices.md"] -- "Add PR description rules" --> B["PR guidelines updated"]

Loading

File Changes

1. best_practices.md 📝 Documentation +2/-0

Add mandatory PR description requirements

• Added requirement that PRs MUST include non-empty descriptions
• Added guideline to flag PRs without descriptions as incomplete
• Inserted two new bullet points in the Pull requests section

best_practices.md

---

[qodo-free-for-open-source-projects]

Code Review by Qodo

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

1. No enforcement implemented 🐞 Bug ✓ Correctness

Description

Despite the PR title/description implying a CI/qodo check, the change only adds documentation text
and does not implement any repository-side enforcement. As a result, PRs with empty descriptions
will not be automatically flagged by this repo’s CI based on this change alone.

Code

best_practices.md[R8-9]

+* PRs MUST include a non-empty description explaining what the change does and why
+* PRs without a description should be flagged as incomplete

Evidence

The PR adds new requirements as markdown bullets in best_practices.md; no executable check is
introduced by this change.

best_practices.md[6-12]

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 claims to “force qodo to check PR desc”, but only adds documentation bullets. If the goal is enforcement, a repo-local check (CI) needs to be added; otherwise the PR’s stated intent is misleading.

## Issue Context
The requirement is currently only expressed as text in `best_practices.md`.

## Fix Focus Areas
- best_practices.md[6-12]
- .github/workflows/* (add a new workflow to validate PR description, or adjust existing workflow set accordingly)

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

---

2. Guidelines out of sync 🐞 Bug ⛯ Reliability

Description

README points contributors to CONTRIBUTING.md for guidelines, but the new PR-description requirement
is only added to best_practices.md. This creates two sources of truth and makes the new requirement
easy to miss for contributors.

Code

best_practices.md[R8-9]

+* PRs MUST include a non-empty description explaining what the change does and why
+* PRs without a description should be flagged as incomplete

Evidence

README explicitly links to CONTRIBUTING.md as the developer guidelines, yet CONTRIBUTING.md’s Pull
requests section does not include the new PR description bullets that now exist in
best_practices.md.

README.md[263-267]
CONTRIBUTING.md[6-11]
best_practices.md[6-12]

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 adds a new contribution requirement, but only in `best_practices.md`. Contributors are directed to `CONTRIBUTING.md`, so the new rule will be missed and the two documents will drift.

## Issue Context
`README.md` links to `CONTRIBUTING.md` as the authoritative contributor guidance.

## Fix Focus Areas
- best_practices.md[6-12]
- CONTRIBUTING.md[6-12]
- README.md[263-267]

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

---

3. Ambiguous “flagged incomplete” 🐞 Bug ✓ Correctness

Description

The phrase “should be flagged as incomplete” is ambiguous about who/what flags it (humans, CI, or a
bot), which can create confusion for contributors. Consider rewording to specify the mechanism or
expected reviewer action.

Code

best_practices.md[9]

+* PRs without a description should be flagged as incomplete

Evidence

The new guideline mandates flagging but does not specify the actor/mechanism, and no enforcement
mechanism is defined in this document.

best_practices.md[8-10]

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 wording implies an enforcement action but doesn’t specify who/what performs it.

## Issue Context
This is currently expressed as a general guideline in markdown.

## Fix Focus Areas
- best_practices.md[8-10]

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

---

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

[qodo-free-for-open-source-projects]

1. No enforcement implemented 🐞 Bug ✓ Correctness

Despite the PR title/description implying a CI/qodo check, the change only adds documentation text
and does not implement any repository-side enforcement. As a result, PRs with empty descriptions
will not be automatically flagged by this repo’s CI based on this change alone.

Agent Prompt

## Issue description
The PR claims to “force qodo to check PR desc”, but only adds documentation bullets. If the goal is enforcement, a repo-local check (CI) needs to be added; otherwise the PR’s stated intent is misleading.

## Issue Context
The requirement is currently only expressed as text in `best_practices.md`.

## Fix Focus Areas
- best_practices.md[6-12]
- .github/workflows/* (add a new workflow to validate PR description, or adjust existing workflow set accordingly)

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