Skip to content

chore: update issue template #910

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.

Sign up for GitHub

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

Closed
arturovt wants to merge 1 commit into from
Closed

chore: update issue template #910

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ description: Report a bug in one of the Transloco packages
title: 'Bug(scope):'

body:
- type: markdown
attributes:
value: |
> **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducable issues. Please delete this note once you have read it.

@cubic-dev-ai cubic-dev-ai Bot Apr 4, 2026 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P3: Fix the typo in the issue template notice (unreproducable → unreproducible).

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At .github/ISSUE_TEMPLATE/bug-report.yaml, line 9:

<comment>Fix the typo in the issue template notice (`unreproducable` → `unreproducible`).</comment>

<file context>
@@ -3,6 +3,11 @@ description: Report a bug in one of the Transloco packages
+  - type: markdown
+    attributes:
+      value: |
+        > **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducable issues. Please delete this note once you have read it.
+
   - type: checkboxes
</file context>
Suggested change
> **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducable issues. Please delete this note once you have read it.
> **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducible issues. Please delete this note once you have read it.
Fix with Cubic


Comment on lines +6 to +10

@coderabbitai coderabbitai Bot Apr 4, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistency between PR objectives and actual changes.

The PR objectives describe adding "PR Checklist" and "PR Type" selection to a pull request template, but this file is a bug report issue template (.github/ISSUE_TEMPLATE/bug-report.yaml). The actual change adds a policy note about reproduction requirements to the issue template, which doesn't match the stated objectives.

Please verify:

  • Is this the intended file for the changes described in the PR objectives?
  • Should there be corresponding changes to a PR template file?
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/bug-report.yaml around lines 6 - 10, The change was
applied to the bug report issue template (the YAML block with "type: markdown"
and its value) but the PR description claims to add "PR Checklist" and "PR Type"
to a pull request template; confirm whether the intent was to edit a PR template
or the bug report; either update the PR objectives to reflect that you're
modifying the bug report note, or move/add the new checklist/type controls to
the actual PR template (create or edit the repository's pull request template
file such as PULL_REQUEST_TEMPLATE.md or .github/pull_request_template) and
remove or adjust the reproduction policy note from the bug-report.yaml if it was
unintended.

⚠️ Potential issue | 🟠 Major

Instruction to delete the note is impossible in YAML form templates.

This is a YAML-based issue template that renders as a web form on GitHub. Markdown blocks (type: markdown) are displayed as static, read-only informational content—users cannot edit or delete them. The instruction "Please delete this note once you have read it" will confuse reporters since they have no way to comply.

Consider either:

  1. Removing the deletion instruction entirely
  2. Converting to a markdown-based template (.md) if you need users to edit content

Also, there's a typo: "unreproducable" should be "unreproducible" (or "non-reproducible").

📝 Proposed fix 
       value: |
-        > **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducable issues. Please delete this note once you have read it.
+        > **Note:** Our policy is that issues reported without a reproduction will be closed immediately and then reopened once a reproduction has been provided. Please respect the developers of this project by doing this. We give of our personal time to work on this project and would rather be spending our time fixing or enhancing the library than chasing down badly described or unreproducible issues.

Fun i18n fact: The word "bug" translates to "böcek" in Turkish, "жук" (zhuk) in Russian, and "虫" (chóng) in Chinese—though in software contexts, many languages simply borrow the English word "bug" or use "error/defecto" instead! 🐛🌍

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/bug-report.yaml around lines 6 - 10, The markdown
block in the YAML issue template (the `type: markdown` block under the `value:`
key) includes an impossible-to-follow instruction ("Please delete this note once
you have read it") and a typo ("unreproducable"); remove the deletion
instruction from that `value` text and correct the typo to "unreproducible" (or
"non-reproducible"), or alternatively replace this YAML `type: markdown` block
by moving the content to a `.md` template if you need editable/deletable
instructions; ensure the change targets the `type: markdown` / `value:` content
in the .github/ISSUE_TEMPLATE/bug-report.yaml.

- type: checkboxes
attributes:
label: Is there an existing issue for this?
Expand Down
Loading