Skip to content

Ran the new template files through prettier #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025
Merged

Ran the new template files through prettier #434

merged 1 commit into from
Jul 8, 2025

Conversation

jmacdotorg
Copy link
Contributor

No description provided.

Copy link
Contributor

coderabbitai bot commented Jul 8, 2025

Walkthrough

The changes update three GitHub issue templates by replacing empty single-quoted strings with empty double-quoted strings for the title field, removing trailing spaces after colons in prompt lines, and eliminating extraneous blank lines at the end of one file. No functional or structural changes were made.

Changes

Files Change Summary
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature-request.md
Changed title field from empty single quotes to double quotes; removed trailing spaces after colons in prompts.
.github/ISSUE_TEMPLATE/other-documentation-request.md Changed title field from empty single quotes to double quotes; removed trailing blank lines.

Poem

A hop and a skip through templates anew,
Swapping quotes—single to double, it's true!
Tidied up prompts, no spaces astray,
The forms are now neater in every way.
With a wiggle of whiskers, I file with delight—
These changes make templates look just right!
🐇✨

Impact Analysis

Minor formatting updates to GitHub issue templates

ℹ️ Low 🔄 Impacts behavior

These changes update the formatting of the GitHub issue templates by switching empty single quotes to double quotes in the title fields, removing trailing spaces after colons, and eliminating extraneous blank lines. There are no changes to the structure, content, or logic of the templates, so users will not experience any functional differences when submitting issues.

Open each updated issue template in the GitHub UI and verify that the templates render as expected and can be submitted without errors. Confirm that the formatting is consistent and no unintended changes appear in the issue creation process.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch templates

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/feature-request.md (1)

9-15: Minor whitespace nitpick

LanguageTool still flags double-space issues after the colons. If you want a perfectly clean lint run, trim any residual spaces after the : on these prompt lines before merging.

-**The name of this feature**:␠
+**The name of this feature**:

(Repeat for the other prompt lines.)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf161a3 and 02b3697.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/bug_report.md (1 hunks)
  • .github/ISSUE_TEMPLATE/feature-request.md (1 hunks)
  • .github/ISSUE_TEMPLATE/other-documentation-request.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: CONTRIBUTING.md:60-65
Timestamp: 2024-10-31T17:01:26.168Z
Learning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
🪛 LanguageTool
.github/ISSUE_TEMPLATE/bug_report.md

[grammar] ~9-~9: Use proper spacing conventions.
Context: ... the documentation page with this bug**: **A brief summary of the documentation bug...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~11-~11: Use proper spacing conventions.
Context: ...rief summary of the documentation bug**: (Optional) **Suggestions on how best we ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

.github/ISSUE_TEMPLATE/feature-request.md

[grammar] ~9-~9: Use proper spacing conventions.
Context: ...otorg --- The name of this feature: Expected launch date: **Personnel (PM...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~11-~11: Use proper spacing conventions.
Context: ...is feature**: Expected launch date: Personnel (PM, TL, etc.): **Summary o...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~13-~13: Use proper spacing conventions.
Context: ...h date**: Personnel (PM, TL, etc.): Summary of this feature, including a h...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~15-~15: Use proper spacing conventions.
Context: ...e public documentation that it requires: **Links to relevant internal documentation...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/bug_report.md (1)

4-4: Consistency update looks good

Switching to double quotes aligns the template with Prettier-formatted YAML conventions.

.github/ISSUE_TEMPLATE/other-documentation-request.md (1)

4-4: No concerns – formatting change only

The quote style change is purely cosmetic and keeps the template consistent with the others.

Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 02b3697
Status: ✅  Deploy successful!
Preview URL: https://7ee5ddc9.coderabbit-docs.pages.dev
Branch Preview URL: https://templates.coderabbit-docs.pages.dev

View logs

@jmacdotorg jmacdotorg merged commit 4cab822 into main Jul 8, 2025
4 checks passed
@jmacdotorg jmacdotorg deleted the templates branch July 8, 2025 18:42
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.

1 participant