Skip to content

docs: add mock device plugin contribution templates - #25

Open
blackdragoon26 wants to merge 2 commits into
Project-HAMi:masterfrom
blackdragoon26:fix-contribution-templates
Open

blackdragoon26 wants to merge 2 commits into
Project-HAMi:masterfrom
blackdragoon26:fix-contribution-templates

Conversation

@blackdragoon26

@blackdragoon26 blackdragoon26 commented Aug 8, 2026

Copy link
Copy Markdown

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds minimal issue and pull request templates tailored to mock device plugin. The bug and question templates request relevant diagnostics while guiding reporters to minimize and mask sensitive data.

Which issue(s) this PR fixes:
Fixes #24

Special notes for your reviewer:

Documentation-only change. The five templates were checked for valid frontmatter, whitespace errors, repository-specific environment fields, and data-minimization guidance.

Does this PR introduce a user-facing change?:

Yes. Contributors receive structured issue and pull request templates.

AI Disclosure:

AI was used only for formatting purposes.

Summary by CodeRabbit

  • Documentation
    • Added standardized templates for reporting bugs, requesting enhancements, asking questions, and proposing beginner-friendly tasks.
    • Added a pull request template with prompts for change classification, context, issue references, reviewer notes, and user-facing impact.
    • Included guidance for providing relevant diagnostics while removing sensitive information.

Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
@hami-robot

hami-robot Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

@blackdragoon26: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds minimal issue and pull request templates tailored to mock device plugin. The bug and question templates request relevant diagnostics while guiding reporters to minimize and mask sensitive data.

Which issue(s) this PR fixes:
Fixes #24

Special notes for your reviewer:

Documentation-only change. The five templates were checked for valid frontmatter, whitespace errors, repository-specific environment fields, and data-minimization guidance.

Does this PR introduce a user-facing change?:

Yes. Contributors receive structured issue and pull request templates.

AI Disclosure:

AI was used only for formatting purposes.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@hami-robot

hami-robot Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: blackdragoon26
Once this PR has been reviewed and has the lgtm label, please assign archlitchi for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@blackdragoon26, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 27 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 371348a6-e052-4878-b096-6d894ec4c723

📥 Commits

Reviewing files that changed from the base of the PR and between 20a5b39 and 921e9b9.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/question.md
📝 Walkthrough

Walkthrough

The repository now includes structured GitHub templates for bug reports, enhancements, good-first issues, questions, and pull requests. The templates collect repository-specific diagnostics, environment details, issue context, review information, and sensitive-data handling guidance.

Changes

Contribution templates

Layer / File(s) Summary
Issue reporting templates
.github/ISSUE_TEMPLATE/*
Added templates for bug reports, enhancements, good-first issues, and questions. The templates collect structured details, diagnostics, environment information, and contributor context.
Pull request submission template
.github/PULL_REQUEST_TEMPLATE.md
Added prompts for pull request type, purpose, linked issues, reviewer notes, user-facing changes, and AI assistance disclosure.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

  • Project-HAMi/ascend-device-plugin#123 — Implements the same repository contribution-template objective.
  • Project-HAMi/amd-device-plugin#14 — Adds the same issue and pull request template set.
  • Project-HAMi/biren-device-plugin#10 — Implements matching GitHub contribution templates.
  • Project-HAMi/volcano-vgpu-device-plugin#147 — Adds the same .github templates.
  • Project-HAMi/HAMi-core#254 — Adds matching issue and pull request templates with diagnostic guidance.
  • Project-HAMi/dcu-vgpu-device-plugin#23 — Implements repository-specific issue and pull request templates.
  • Project-HAMi/HAMi-DRA#81 — Adds the requested issue templates and a pull request template.

Suggested reviewers: archlitchi, dsfans2014

Poem

A rabbit hops through forms of white,
Bug clues gathered neat and right.
Questions, features, pull requests too,
Each template guides what teams should do.
Thump, thump—clear contributions grow!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the addition of repository-specific contribution templates for the mock device plugin.
Linked Issues check ✅ Passed The five templates address the repository-specific issue and pull request template requirements, including diagnostics, sanitization guidance, and issue linkage [#24].
Out of Scope Changes check ✅ Passed All changes add contribution templates that directly support the objectives in issue #24; no unrelated changes are present.
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

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.

@hami-robot hami-robot Bot added the size/L label Aug 8, 2026
@blackdragoon26
blackdragoon26 marked this pull request as ready for review August 8, 2026 15:38

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/question.md:
- Around line 7-22: Expand the question template after the existing Environment
prompts with explicit requests for the relevant hami-scheduler-device ConfigMap
section, sanitized hami.io/node-*-register annotations, node capacity and
allocatable resources, time-bounded component logs, and a minimal manifest or
reproduction command when applicable. Keep the existing credential and
identifier redaction guidance.
🪄 Autofix

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 Plus

Run ID: eb88f0d5-ebf7-4245-85af-f4b3d2a7139c

📥 Commits

Reviewing files that changed from the base of the PR and between d3b1687 and 20a5b39.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/bug-report.md
  • .github/ISSUE_TEMPLATE/enhancement.md
  • .github/ISSUE_TEMPLATE/good-first.md
  • .github/ISSUE_TEMPLATE/question.md
  • .github/PULL_REQUEST_TEMPLATE.md

Comment thread .github/ISSUE_TEMPLATE/question.md
Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add repository-specific issue and pull request templates

1 participant