Skip to content

Remove issue/PR templates and add conventions to AGENTS.md#658

Merged
dahlia merged 5 commits intofedify-dev:mainfrom
sij411:chore/templates
Apr 3, 2026
Merged

Remove issue/PR templates and add conventions to AGENTS.md#658
dahlia merged 5 commits intofedify-dev:mainfrom
sij411:chore/templates

Conversation

@sij411
Copy link
Copy Markdown
Contributor

@sij411 sij411 commented Apr 3, 2026

Summary

  • Remove GitHub issue and pull request templates (.github/ISSUE_TEMPLATE/, .github/pull_request_template.md) since they are not being used widely enough
  • Add "Issues and PR descriptions" section to AGENTS.md with conventions: no 80-column wrapping, follow existing Markdown conventions, use #123 shorthand for references, and include rationales in descriptions

Notes

  • It would be appreciated if you check changed conventions are reasonable.

🤖 Generated with Claude Code

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 3, 2026

📝 Walkthrough

Walkthrough

All repository issue templates and the pull request template were removed. AGENTS.md was updated with a new "Issues and PR descriptions" section requiring no 80-column wrapping, using #123 shorthand references, and including rationale/background in descriptions.

Changes

Cohort / File(s) Summary
GitHub Issue Templates Removed
​.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
Deleted all structured GitHub issue templates: metadata, labels, form schemas, validation rules, and guidance.
Pull Request Template Removed
​.github/PULL_REQUEST_TEMPLATE.md
Deleted the repository PR template and its checklist/section prompts.
Documentation Update
AGENTS.md
Added "Issues and PR descriptions" section: disables 80-column wrapping for that section, mandates #123 issue/PR references, and requires inclusion of rationale/background in descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: removing issue/PR templates and adding conventions to AGENTS.md.
Description check ✅ Passed The description clearly explains the purpose and rationale for removing templates and adding conventions, directly related to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@issues-auto-labeler issues-auto-labeler bot added component/build Build system and packaging component/cli CLI tools related component/ci CI/CD workflows and GitHub Actions labels Apr 3, 2026
@sij411 sij411 force-pushed the chore/templates branch from 5a2189a to d376eb5 Compare April 3, 2026 07:55
@dahlia dahlia self-assigned this Apr 3, 2026
@sij411 sij411 marked this pull request as ready for review April 3, 2026 07:56
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between bd60323 and 2092042.

⛔ Files ignored due to path filters (1)
  • deno.lock is 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.md
  • AGENTS.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
Copy link
Copy Markdown

codecov bot commented Apr 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sij411 and others added 2 commits April 3, 2026 18:01
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sij411 sij411 force-pushed the chore/templates branch from 2092042 to d132f20 Compare April 3, 2026 09:02
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (2)
AGENTS.md (2)

355-357: ⚠️ Potential issue | 🟡 Minor

Clarify 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 | 🟠 Major

Resolve 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2092042 and d132f20.

⛔ Files ignored due to path filters (1)
  • deno.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • AGENTS.md

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
AGENTS.md (1)

359-359: ⚠️ Potential issue | 🟠 Major

Resolve cross-document reference-style conflict (#123 vs 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 38a57164-93fb-4efa-b274-fe8829ec0cfa

📥 Commits

Reviewing files that changed from the base of the PR and between d132f20 and 847975a.

📒 Files selected for processing (1)
  • AGENTS.md

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
AGENTS.md (1)

359-359: ⚠️ Potential issue | 🟠 Major

Resolve cross-document reference-style conflict (#123 vs 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 38a57164-93fb-4efa-b274-fe8829ec0cfa

📥 Commits

Reviewing files that changed from the base of the PR and between d132f20 and 847975a.

📒 Files selected for processing (1)
  • AGENTS.md

Copy link
Copy Markdown
Member

@dahlia dahlia left a comment

Choose a reason for hiding this comment

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

Good job!

@dahlia dahlia merged commit 68880cd into fedify-dev:main Apr 3, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/build Build system and packaging component/ci CI/CD workflows and GitHub Actions component/cli CLI tools related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants