Skip to content

chore: update issue template#910

Open
arturovt wants to merge 1 commit intomasterfrom
chore/update-issue-template
Open

chore: update issue template#910
arturovt wants to merge 1 commit intomasterfrom
chore/update-issue-template

Conversation

@arturovt
Copy link
Copy Markdown
Collaborator

@arturovt arturovt commented Apr 4, 2026

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Documentation content changes

Summary by cubic

Add a note to the bug report issue template requiring a reproduction; reports without one will be closed and reopened once provided. This clarifies expectations and reduces time spent triaging unreproducible issues.

Written for commit a86ca53. Summary will update on new commits.

Summary by CodeRabbit

Chores

  • Updated the bug report template to provide clearer guidance to issue reporters. The template now includes important policy information regarding reproduction requirements and submission expectations, along with practical instructions to help community members submit higher-quality bug reports and improve the overall issue management process.

@arturovt arturovt requested a review from shaharkazaz April 4, 2026 21:39
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 4, 2026

📝 Walkthrough

Walkthrough

The pull request adds an informational markdown note to the bug report issue template, outlining a policy for issues submitted without reproduction steps. The note includes instructions for reporters to delete it after reading. The modification is minimal and does not alter the template's structure or validation rules.

Changes

Cohort / File(s) Summary
Issue Template Updates
.github/ISSUE_TEMPLATE/bug-report.yaml
Added a 5-line markdown note at the start of the bug report template body informing reporters of the policy for non-reproducible issues and instructing them to delete the note after reading.

Fun fact: Did you know that the term "bug" in software was inspired by an actual moth found in a computer in 1947? Admiral Grace Hopper's team discovered the insect in a Harvard Mark II computer, and it became the origin of the term "debugging"—making bug reports a tradition that dates back nearly 80 years!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: update issue template' accurately reflects the main change—updating the bug report template with a new note about reproduction requirements.
Description check ✅ Passed The description includes the PR Checklist with verified commit guidelines, PR Type marked as 'Documentation content changes', and an auto-generated summary explaining the purpose of the template update.
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 chore/update-issue-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 4, 2026

Open in StackBlitz

@jsverse/transloco

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco@910

@jsverse/transloco-locale

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-locale@910

@jsverse/transloco-messageformat

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-messageformat@910

@jsverse/transloco-optimize

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-optimize@910

@jsverse/transloco-persist-lang

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-persist-lang@910

@jsverse/transloco-persist-translations

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-persist-translations@910

@jsverse/transloco-preload-langs

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-preload-langs@910

@jsverse/transloco-schematics

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-schematics@910

@jsverse/transloco-scoped-libs

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-scoped-libs@910

@jsverse/transloco-utils

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-utils@910

@jsverse/transloco-validator

npm i https://pkg.pr.new/jsverse/transloco/@jsverse/transloco-validator@910

commit: a86ca53

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 @.github/ISSUE_TEMPLATE/bug-report.yaml:
- Around line 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.
- Around line 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.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 30053692-d62c-486c-81f4-55784ea583ef

📥 Commits

Reviewing files that changed from the base of the PR and between 7295105 and a86ca53.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug-report.yaml

Comment on lines +6 to +10
- 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.

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.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name=".github/ISSUE_TEMPLATE/bug-report.yaml">

<violation number="1" location=".github/ISSUE_TEMPLATE/bug-report.yaml:9">
P3: Fix the typo in the issue template notice (`unreproducable` → `unreproducible`).</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

- 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.
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot Apr 4, 2026

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 (unreproducableunreproducible).

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

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