Skip to content

Conversation

@jhelison
Copy link
Contributor

Description

Update the issue template for the repository

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (updates documentation on the project)
  • chore (Updates on dependencies, gitignore, etc)
  • test (For updates on tests)

Copilot AI review requested due to automatic review settings December 24, 2025 14:13
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 24, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

This pull request replaces the GitHub bug report issue template for Kiichain. It updates YAML front matter (about, title, labels), adds a prominent "AI-GENERATED CONTENT IS NOT ACCEPTED" notice, restructures prompts into named sections (Bug Description, Steps to Reproduce, Expected Behavior, Actual Behavior), and introduces new sections for Environment, Impact Assessment, and a Reporter Declaration with verification checkboxes. Device-specific fields are consolidated and the overall template is expanded and reformatted for stricter reporting requirements.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update issue template' is concise and clearly describes the main change—updating the bug report template with new sections and validation criteria.
Description check ✅ Passed The description is related to the changeset, correctly identifying the change as a chore affecting the issue template, though it lacks detail about the specific improvements made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • 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.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the bug report issue template to replace a generic template with a comprehensive, Kiichain-specific structure that emphasizes quality standards and discourages AI-generated submissions.

  • Adds strict guidelines against AI-generated bug reports with clear expectations for testing and validation
  • Restructures the template into well-organized sections including Bug Description, Steps to Reproduce, Expected/Actual Behavior, Environment, Impact Assessment, and Reporter Declaration
  • Updates metadata to include pre-filled bug label and structured title format

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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/bug_report.md (1)

9-21: Consider converting the emphasized pre-submission notice to a Markdown heading.

The bold-emphasized text on line 11 (**AI-GENERATED CONTENT IS NOT ACCEPTED**) violates markdown style rule MD036, which discourages using emphasis for heading-like content. Converting this section to a proper heading would improve stylistic consistency:

## IMPORTANT – READ BEFORE SUBMITTING

-**AI-GENERATED CONTENT IS NOT ACCEPTED**
+### AI-GENERATED CONTENT IS NOT ACCEPTED

This keeps the critical notice visually prominent while respecting markdown conventions.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c2ef0a2 and ff9c906.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug_report.md
🧰 Additional context used
🪛 LanguageTool
.github/ISSUE_TEMPLATE/bug_report.md

[style] ~91-~91: This phrase is often redundant. Consider writing “I” unless you want to emphasize that you and not someone else will do something. Then, commas might be missing.
Context: ...report is NOT generated by AI - [ ] I personally tested and verified this issue - [ ] I ...

(I_MYSELF)

🪛 markdownlint-cli2 (0.18.1)
.github/ISSUE_TEMPLATE/bug_report.md

11-11: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ 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: Upload results
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)

1-92: Excellent template improvements for bug report rigor.

The restructured template significantly raises the bar for actionable bug reports:

  • Clear enforcement against low-effort/AI-generated submissions with explicit upfront warning
  • Progressive disclosure of required fields (Bug Description → Steps to Reproduce → Environment → Impact)
  • Concrete examples (e.g., in "Steps to Reproduce") guide reporters on specificity
  • New "Impact Assessment" section helps prioritize issues by severity
  • Reporter Declaration checkboxes create accountability and discourage speculative reports
  • Metadata updates (title prefix, labels) improve issue categorization and discoverability

The template balances comprehensiveness with usability. This should meaningfully improve signal-to-noise for maintainers.

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

♻️ Duplicate comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)

75-82: Add format guidance to the Impact Assessment section.

This resolves a previous review comment: The section lists potential impacts but doesn't clarify how users should respond (e.g., "Select all that apply:", "Check if any apply:", or "Describe which of the following apply:"). Without clear instructions, responses will be inconsistent.

🔎 Proposed fix
 ## Impact Assessment
 
-Explain the **impact of this bug**:
+Explain the **impact of this bug** (select all that apply):
 - Consensus failure
 - Fund loss
 - Security risk
 - Incorrect behavior
 - Performance degradation
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff9c906 and ee466d3.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug_report.md
🧰 Additional context used
🪛 LanguageTool
.github/ISSUE_TEMPLATE/bug_report.md

[style] ~91-~91: This phrase is often redundant. Consider writing “I” unless you want to emphasize that you and not someone else will do something. Then, commas might be missing.
Context: ...report is NOT generated by AI - [ ] I personally tested and verified this issue - [ ] I ...

(I_MYSELF)

🪛 markdownlint-cli2 (0.18.1)
.github/ISSUE_TEMPLATE/bug_report.md

11-11: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)

3-5: LGTM – Template restructuring is comprehensive and well-organized.

The YAML front matter updates are clear (about, title, labels properly defined), and the overall restructuring with named sections, environment requirements, and reporter checkboxes significantly improves bug report quality. The grammar fix at line 30 ("Why is this a bug") is correctly applied.

Also applies to: 7-7

@jhelison jhelison merged commit 359cfae into main Dec 24, 2025
6 of 7 checks passed
@jhelison jhelison deleted the chore/update-issue-template branch December 24, 2025 15:14
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.

3 participants