added escape-character

[SirMDA]

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Does this PR introduce a breaking change?

e.g. is old functionality not usable anymore

Most important changes

Which files functionalities are most important in this PR. On which part should the reviewer be focussed on?

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works (might be obsolete with CI later on)
• New and existing unit tests pass locally with my changes (might be obsolete with CI later on)

Summary by CodeRabbit

• Chores
  • Updated placeholder text in issue templates to escape the hash symbol, ensuring it is treated as a literal character in Markdown.
  • Changes made to the "Dependencies" textarea in the Bug, Feature, and Issue templates for clarity.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the placeholder text in three GitHub issue template files: BUG.yml, FEATURE.yml, and ISSUE.yml. Each file's "Dependencies" textarea placeholder has been updated to escape the hash symbol, ensuring it is treated as a literal character in Markdown. This adjustment prevents the hash symbol from being interpreted as a special character, with no other alterations made to the structure or content of the templates.

Changes

File Path	Change Summary
.github/ISSUE_TEMPLATE/BUG.yml	Updated placeholder text from "Link dependencies here (e.g., #123)." to "Link dependencies here (e.g., #123)."
.github/ISSUE_TEMPLATE/FEATURE.yml	Updated placeholder text from "Link dependencies here (e.g., #456)" to "Link dependencies here (e.g., #456)."
.github/ISSUE_TEMPLATE/ISSUE.yml	Updated placeholder text from "Link dependencies here (e.g., the issue #789)." to "Link dependencies here (e.g., the issue #789)."

Possibly related PRs

• updated issue templates #463: The changes in this PR also involve updating the placeholder text for the "Dependencies" field in the .github/ISSUE_TEMPLATE/FEATURE.yml and .github/ISSUE_TEMPLATE/ISSUE.yml files, similar to the changes made in the main PR for the .github/ISSUE_TEMPLATE/BUG.yml file.

Suggested reviewers

• asamluka

Poem

In templates where issues are found,
A hash symbol's escape now abound.
With placeholders clear,
No confusion near,
Our bugs and features are sound! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d1cf534 and 46451ef.

📒 Files selected for processing (3)

• .github/ISSUE_TEMPLATE/BUG.yml (1 hunks)
• .github/ISSUE_TEMPLATE/FEATURE.yml (1 hunks)
• .github/ISSUE_TEMPLATE/ISSUE.yml (1 hunks)

✅ Files skipped from review due to trivial changes (3)

• .github/ISSUE_TEMPLATE/BUG.yml
• .github/ISSUE_TEMPLATE/FEATURE.yml
• .github/ISSUE_TEMPLATE/ISSUE.yml

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.