Skip to content

fix(doc): modify the template title#9

Merged
Sunny6889 merged 1 commit intodevelopfrom
fix_issue_template
Mar 19, 2026
Merged

fix(doc): modify the template title#9
Sunny6889 merged 1 commit intodevelopfrom
fix_issue_template

Conversation

@Sunny6889
Copy link
Copy Markdown
Owner

@Sunny6889 Sunny6889 commented Mar 19, 2026

What does this PR do?

  • Modify the issue template title to lower case.

Why are these changes required?

This PR has been tested by:

  • Manual Testing

Follow up

Extra details

Summary by CodeRabbit

  • Chores
    • Improved GitHub issue template titles with consistent capitalization and removed trailing spaces from default bug report, feature request, and question issue titles for cleaner formatting.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 19, 2026

📝 Walkthrough

Walkthrough

Three GitHub issue template title prefixes standardized: changed from uppercase format with trailing spaces (e.g., [QUESTION] , [BUG] , [FEATURE] ) to title case without trailing spaces (e.g., [Question], [Bug], [Feature]).

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/ask-a-question.md, .github/ISSUE_TEMPLATE/report-a-bug.md, .github/ISSUE_TEMPLATE/request-a-feature.md
Updated issue template title field prefix from uppercase with trailing space to title case without trailing space.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Three templates dressed in proper case,
No trailing spaces cluttering the place,
From QUESTION to Question, a subtle grace,
Bug reports now bloom in refined embrace! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The PR title 'fix(doc): modify the template title' is vague and generic. While it mentions modifying 'the template title,' it doesn't specify which templates or what the actual change is—converting uppercase labels to proper case formatting. Consider a more specific title like 'fix(doc): normalize GitHub issue template title prefixes to proper case' to better convey the actual changes made across all three templates.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Commit unit tests in branch fix_issue_template
📝 Coding Plan
  • Generate coding plan for human review comments

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

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: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/ask-a-question.md:
- Line 4: Update the frontmatter title token to use lowercase to match the PR
goal: change the YAML key "title" value from '[Question]' to '[question]' so the
template's title token is lowercase and consistent with the stated objective.

In @.github/ISSUE_TEMPLATE/report-a-bug.md:
- Line 4: Update the YAML frontmatter key value for the issue template by
changing the title value from '[Bug]' to lowercase '[bug]' so it matches the PR
objective; locate the "title" entry in the template (the line containing title:
'[Bug]') and replace the bracketed value with '[bug]'.

In @.github/ISSUE_TEMPLATE/request-a-feature.md:
- Line 4: The template's title line currently uses a capitalized tag "title:
'[Feature]'" which violates the lowercase requirement; update that literal to
"title: '[feature]'" so the title token matches the PR objective exactly (look
for the title: '[Feature]' line in the file and replace it with title:
'[feature]').

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 04dfa170-20d2-433c-94af-39fa0755ab89

📥 Commits

Reviewing files that changed from the base of the PR and between 7e5bbbd and 3ad590e.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/ask-a-question.md
  • .github/ISSUE_TEMPLATE/report-a-bug.md
  • .github/ISSUE_TEMPLATE/request-a-feature.md

@Sunny6889 Sunny6889 merged commit bbf3369 into develop Mar 19, 2026
13 checks passed
@Sunny6889 Sunny6889 deleted the fix_issue_template branch March 19, 2026 08:28
@coderabbitai coderabbitai bot mentioned this pull request Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants