Remove issue/PR templates and add conventions to AGENTS.md#658
Remove issue/PR templates and add conventions to AGENTS.md#658dahlia merged 5 commits intofedify-dev:mainfrom
Conversation
📝 WalkthroughWalkthroughAll repository issue templates and the pull request template were removed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Code Review
This pull request removes all GitHub issue and pull request templates and updates AGENTS.md with new instructions for issue and PR descriptions. The review feedback identifies a conflict where the new instructions suggest using shorthand issue references, violating the repository's style guide which requires permalink URLs. Additionally, minor formatting corrections were requested for a section heading underline and a missing trailing newline.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 355-357: The bullet that currently states "Unlike other Markdown
files in this repository, do not wrap lines at 80 columns" should be clarified
to apply only to issue and PR descriptions; update that sentence to explicitly
read something like "For issue and pull request descriptions only, do not wrap
lines at 80 columns" so it no longer appears as a repository-wide Markdown
exception and keeps the rest of the Markdown conventions intact.
- Line 359: AGENTS.md currently instructs "Use `#123` shorthand for issue and PR
references", which conflicts with the project's canonical rule in
CONTRIBUTING.md that requires permalink URLs; pick the canonical format (use
permalink URLs), update the AGENTS.md bullet text to match the CONTRIBUTING.md
wording (replace the `#123` shorthand line with a statement requiring permalink
URLs for issues/PRs), and scan AGENTS.md for any other references to the
shorthand (e.g., the conflicting guidance near the other section) to make them
consistent with the permalink convention so contributors/agents won't produce
mixed formats.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: c6b80da8-e327-4ab8-b218-a6d3d927b428
⛔ Files ignored due to path filters (1)
deno.lockis excluded by!**/*.lock
📒 Files selected for processing (10)
.github/ISSUE_TEMPLATE/bug-report.yml.github/ISSUE_TEMPLATE/chore.yml.github/ISSUE_TEMPLATE/document.yml.github/ISSUE_TEMPLATE/enhancement.yml.github/ISSUE_TEMPLATE/feature.yml.github/ISSUE_TEMPLATE/performance.yml.github/ISSUE_TEMPLATE/refactor.yml.github/ISSUE_TEMPLATE/test.yml.github/PULL_REQUEST_TEMPLATE.mdAGENTS.md
💤 Files with no reviewable changes (9)
- .github/ISSUE_TEMPLATE/performance.yml
- .github/ISSUE_TEMPLATE/enhancement.yml
- .github/ISSUE_TEMPLATE/feature.yml
- .github/ISSUE_TEMPLATE/chore.yml
- .github/ISSUE_TEMPLATE/test.yml
- .github/ISSUE_TEMPLATE/bug-report.yml
- .github/ISSUE_TEMPLATE/document.yml
- .github/PULL_REQUEST_TEMPLATE.md
- .github/ISSUE_TEMPLATE/refactor.yml
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
♻️ Duplicate comments (2)
AGENTS.md (2)
355-357:⚠️ Potential issue | 🟡 MinorClarify scope of the "no 80-column wrap" exception.
The current wording can be read as a broad Markdown exception. Explicitly scope it to issue/PR descriptions only to avoid conflicting interpretations with other Markdown conventions.
Suggested wording tweak
- - Unlike other Markdown files in this repository, do not wrap lines at - 80 columns + - For issue and PR descriptions only, do not wrap lines at 80 columns🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 355 - 357, The sentence that currently states "Unlike other Markdown files in this repository, do not wrap lines at 80 columns" is too broad; update that line to limit the exception to issue and PR descriptions only by rewording it to something like "For issue and PR descriptions, do not wrap lines at 80 columns; other Markdown files should follow the repository's wrapping conventions" so the rule for wrapping remains unchanged for docs while allowing unwrapped prose in issues/PRs—edit the text containing the "do not wrap lines at 80 columns" phrase accordingly in AGENTS.md.
359-359:⚠️ Potential issue | 🟠 MajorResolve conflicting reference format guidance.
Line 359 conflicts with existing guidance in Line 262 of this same file and with
CONTRIBUTING.md:299-331(permalink URLs required). Please keep one canonical rule; otherwise contributors/agents will produce inconsistent descriptions.Suggested fix (align with existing project-wide permalink convention)
- - Use `#123` shorthand for issue and PR references instead of permalink URLs + - Use permalink URLs for issue and PR references instead of `#123` shorthand🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 359, Resolve the conflicting reference-format guidance by removing or replacing the shorthand rule "- Use `#123` shorthand for issue and PR references" in AGENTS.md and make the file follow the project-wide canonical rule used in CONTRIBUTING.md (permalink URLs required); update the AGENTS.md guidance text to explicitly require permalink URLs for issue/PR references and ensure any examples or other sentences in AGENTS.md that recommend `#123` are changed to show permalink usage so the two documents are consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@AGENTS.md`:
- Around line 355-357: The sentence that currently states "Unlike other Markdown
files in this repository, do not wrap lines at 80 columns" is too broad; update
that line to limit the exception to issue and PR descriptions only by rewording
it to something like "For issue and PR descriptions, do not wrap lines at 80
columns; other Markdown files should follow the repository's wrapping
conventions" so the rule for wrapping remains unchanged for docs while allowing
unwrapped prose in issues/PRs—edit the text containing the "do not wrap lines at
80 columns" phrase accordingly in AGENTS.md.
- Line 359: Resolve the conflicting reference-format guidance by removing or
replacing the shorthand rule "- Use `#123` shorthand for issue and PR
references" in AGENTS.md and make the file follow the project-wide canonical
rule used in CONTRIBUTING.md (permalink URLs required); update the AGENTS.md
guidance text to explicitly require permalink URLs for issue/PR references and
ensure any examples or other sentences in AGENTS.md that recommend `#123` are
changed to show permalink usage so the two documents are consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 70bc0c89-febb-481f-8c71-db7343afd65a
⛔ Files ignored due to path filters (1)
deno.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
AGENTS.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
AGENTS.md (1)
359-359:⚠️ Potential issue | 🟠 MajorResolve cross-document reference-style conflict (
#123vs permalink URLs).Line 359 conflicts with existing guidance in this file (Line 262) and CONTRIBUTING.md (permalink URLs). Keep one canonical rule to avoid mixed issue/PR reference formats across commit messages and descriptions.
Suggested change
- - Use `#123` shorthand for issue and PR references instead of permalink URLs + - Use permalink URLs for issue and PR references🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 359, There is a conflicting guideline about issue/PR reference format—one line uses `#123` shorthand while CONTRIBUTING.md and another section use permalink URLs; choose a single canonical rule (e.g., use `#123` shorthand) and update all occurrences to match that rule: replace permalink-style URLs with `#<number>` references in the AGENTS.md section currently referencing issues/PRs and harmonize the same rule in CONTRIBUTING.md and the other AGENTS.md section; ensure the guidance text (the bullet that currently reads "Use `#123` shorthand for issue and PR references instead of permalink URLs") is the canonical wording and remove the duplicate/conflicting line so only one authoritative instruction remains.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@AGENTS.md`:
- Line 359: There is a conflicting guideline about issue/PR reference format—one
line uses `#123` shorthand while CONTRIBUTING.md and another section use
permalink URLs; choose a single canonical rule (e.g., use `#123` shorthand) and
update all occurrences to match that rule: replace permalink-style URLs with
`#<number>` references in the AGENTS.md section currently referencing issues/PRs
and harmonize the same rule in CONTRIBUTING.md and the other AGENTS.md section;
ensure the guidance text (the bullet that currently reads "Use `#123` shorthand
for issue and PR references instead of permalink URLs") is the canonical wording
and remove the duplicate/conflicting line so only one authoritative instruction
remains.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
AGENTS.md (1)
359-359:⚠️ Potential issue | 🟠 MajorResolve cross-document reference-style conflict (
#123vs permalink URLs).Line 359 conflicts with existing guidance in this file (Line 262) and CONTRIBUTING.md (permalink URLs). Keep one canonical rule to avoid mixed issue/PR reference formats across commit messages and descriptions.
Suggested change
- - Use `#123` shorthand for issue and PR references instead of permalink URLs + - Use permalink URLs for issue and PR references🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 359, There is a conflicting guideline about issue/PR reference format—one line uses `#123` shorthand while CONTRIBUTING.md and another section use permalink URLs; choose a single canonical rule (e.g., use `#123` shorthand) and update all occurrences to match that rule: replace permalink-style URLs with `#<number>` references in the AGENTS.md section currently referencing issues/PRs and harmonize the same rule in CONTRIBUTING.md and the other AGENTS.md section; ensure the guidance text (the bullet that currently reads "Use `#123` shorthand for issue and PR references instead of permalink URLs") is the canonical wording and remove the duplicate/conflicting line so only one authoritative instruction remains.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@AGENTS.md`:
- Line 359: There is a conflicting guideline about issue/PR reference format—one
line uses `#123` shorthand while CONTRIBUTING.md and another section use
permalink URLs; choose a single canonical rule (e.g., use `#123` shorthand) and
update all occurrences to match that rule: replace permalink-style URLs with
`#<number>` references in the AGENTS.md section currently referencing issues/PRs
and harmonize the same rule in CONTRIBUTING.md and the other AGENTS.md section;
ensure the guidance text (the bullet that currently reads "Use `#123` shorthand
for issue and PR references instead of permalink URLs") is the canonical wording
and remove the duplicate/conflicting line so only one authoritative instruction
remains.
Summary
.github/ISSUE_TEMPLATE/,.github/pull_request_template.md) since they are not being used widely enoughAGENTS.mdwith conventions: no 80-column wrapping, follow existing Markdown conventions, use#123shorthand for references, and include rationales in descriptionsNotes
🤖 Generated with Claude Code