SSWConsulting / SSWConsulting/SSW.Rules

✨ DevOps - Implement PR Description Quality Check

Open
#1,725 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

02-medium Type: Feature
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Requested by: @wicksipedia via YakShaver.ai 🦬
cc: @wicksipedia, @calumjs, @bradystroud, @uly1, @adamcogan, @christianmorfordwaitessw

Hi Team!

🟥  Watch the video (1 min 12 sec)

  Url from screen share: https://github.com/SSWConsulting/SSW.Rules.Content/pull/10176

Pain

Implement a PR check that blocks pull requests from being merged if the description is inadequate or automatically generated without meaningful content. This will ensure that all PRs have clear and informative descriptions, detailing what changed and why.

Acceptance Criteria
  1. A PR cannot be merged if the description contains only emojis or is automatically generated without meaningful content.
  2. The system should identify and block PRs with descriptions that are inadequate or only contain phrases like 'automatically generated by TinaCMS'.
  3. Provide feedback to the user on why the PR is blocked and what needs to be improved in the description.
  4. Ensure that the feature is integrated into the existing PR workflow without disrupting other functionalities.
Screenshot

Screenshot
Figure: PR descriptions lack detail, need automatic blocking for inadequate descriptions.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by inspecting the repository's existing pull-request workflow and how TinaCMS-generated descriptions enter it. Define checks for emoji-only and automatically generated descriptions, then verify that blocked PRs receive actionable feedback without affecting other workflow behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.