Skip to content

fixed the PR template#477

Open
antedotee wants to merge 1 commit into
krkn-chaos:mainfrom
antedotee:fix-pr-template
Open

fixed the PR template#477
antedotee wants to merge 1 commit into
krkn-chaos:mainfrom
antedotee:fix-pr-template

Conversation

@antedotee

Copy link
Copy Markdown
Contributor

Fixed the PR template to prevent maintainers manually closing the issue and contributors from manually deleting the line. Now, they can write directly what changes they have made and raise PR. I think, it reduces a bit of friction while raising PR.

Fixes #455

@netlify

netlify Bot commented May 18, 2026

Copy link
Copy Markdown

Deploy Preview for krkn-chaos ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 71a3738
🔍 Latest deploy log https://app.netlify.com/projects/krkn-chaos/deploys/6a0f327335adb200086e6b88
😎 Deploy Preview https://deploy-preview-477--krkn-chaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Improve PR template with issue references and comments

✨ Enhancement

Grey Divider

Walkthroughs

Description
• Improved PR template with issue reference field
• Converted instructions to comments to reduce clutter
• Simplified template structure for better contributor experience
Diagram
flowchart LR
  A["Old PR Template"] -->|Add issue reference| B["New PR Template"]
  A -->|Convert to comments| B
  B -->|Cleaner interface| C["Better UX"]
Loading

Grey Divider

File Changes

1. .github/PULL_REQUEST_TEMPLATE.md ✨ Enhancement +8/-5

Streamline PR template with issue references

• Added Fixes #<!-- issue number --> field for automatic issue linking
• Converted instructional text to HTML comments to reduce visual clutter
• Removed empty Related Feature field and replaced with issue reference
• Simplified Changes section with inline comment guidance

.github/PULL_REQUEST_TEMPLATE.md


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 18, 2026

Copy link
Copy Markdown

Code Review by Qodo

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

Context used

Grey Divider


Action required

1. **Changes:** still present 📎 Requirement gap ⚙ Maintainability
Description
The PR template still includes the word Changes as a standalone section header, which violates the
requirement to remove that wording from the template area. This can reintroduce the exact phrasing
the ticket requested to eliminate.
Code

.github/PULL_REQUEST_TEMPLATE.md[10]

+**Changes:**
Evidence
PR Compliance ID 3 requires removing the word changes from the template. The updated template
still includes **Changes:** on the added line, so the failure criteria is met.

Remove the word 'changes' from the top of the PR template section
.github/PULL_REQUEST_TEMPLATE.md[10-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 PR template still contains the word `Changes` as a section header (`**Changes:**`), but the compliance requirement is to remove the word `changes` from the top/template area referenced by the ticket.

## Issue Context
This PR is intended to adjust PR template wording; keeping `**Changes:**` fails the checklist requirement.

## Fix Focus Areas
- .github/PULL_REQUEST_TEMPLATE.md[10-11]

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



Advisory comments

2. Fixes placeholder hard to fill 🐞 Bug ⚙ Maintainability
Description
The template uses Fixes #<!-- issue number -->, where the HTML comment starts immediately after
#, making it awkward to insert the issue number without editing/removing the comment and
increasing the chance the placeholder is left unchanged. This undermines the intent of reliably
linking/closing the referenced issue from the PR description.
Code

.github/PULL_REQUEST_TEMPLATE.md[2]

+Fixes #<!-- issue number -->
Evidence
The template line places the HTML comment delimiter directly after #, so inserting the issue
number requires editing inside the token (between # and <!--) or removing the comment entirely.

.github/PULL_REQUEST_TEMPLATE.md[1-3]

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 template currently has `Fixes #<!-- issue number -->`, which places an HTML comment immediately after `#`, making it easy to leave the placeholder unchanged or requiring awkward editing.

### Issue Context
This is a contributor-facing template field; making the placeholder easy to fill improves consistency.

### Fix Focus Areas
- .github/PULL_REQUEST_TEMPLATE.md[2-2]

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


Grey Divider

Qodo Logo

**Changes:**

Describe the documentation updates made for the feature.
**Changes:**

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. changes: still present 📎 Requirement gap ⚙ Maintainability

The PR template still includes the word Changes as a standalone section header, which violates the
requirement to remove that wording from the template area. This can reintroduce the exact phrasing
the ticket requested to eliminate.
Agent Prompt
## Issue description
The PR template still contains the word `Changes` as a section header (`**Changes:**`), but the compliance requirement is to remove the word `changes` from the top/template area referenced by the ticket.

## Issue Context
This PR is intended to adjust PR template wording; keeping `**Changes:**` fails the checklist requirement.

## Fix Focus Areas
- .github/PULL_REQUEST_TEMPLATE.md[10-11]

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

<!--
Please include the branch name where you have made changes or added new
features/scenario that we need on the website (e.g., `krkn/new_scenario`)
in the title of this PR.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we're making changes here, would be good if we could reword. I got confused by your issue because it references "the website" even though you're in this repo already

@antedotee

Copy link
Copy Markdown
Contributor Author

Done. Please take a look.

Signed-off-by: antedotee <soniyadav2051982@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The PR template can be made better

2 participants