SSWConsulting / SSWConsulting/SSW.Rules.Content

♻️ Improve auto generated PR description from bot

Open
#9,562 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
62
Forks
196
Avg merge
1d 4h
Merged PRs (30d)
112

Description

Cc: @bradystroud @tiagov8 @adamcogan @BrookJeynes @Aibono1225

Email Subject - Re: SSW.Rules.Content - Reviewing GitHub Actions PRs

Pain

The auto-generated PR description that has been created by github-actions bot is not clear.

**Example: ** There are no links to rules - https://github.com/SSWConsulting/SSW.Rules.Content/pull/9516

More

PR in example is created when there are duplicate image names for different rules. See more on wiki - https://github.com/SSWConsulting/SSW.Rules.Content/wiki/GitHub-Action---Check-For-Duplicate-Image-Names

Tasks
  • Configure the bot to generate better description with links to rules

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

Start by inspecting the GitHub Actions workflow that creates duplicate-image-name PRs, then compare its generated description with PR #9516 and the linked wiki guidance. Done means the bot-generated description clearly links to the affected rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.