Skip to content

docs: add AMD contribution templates - #15

Open
blackdragoon26 wants to merge 1 commit into
Project-HAMi:mainfrom
blackdragoon26:fix/contribution-templates
Open

docs: add AMD contribution templates#15
blackdragoon26 wants to merge 1 commit into
Project-HAMi:mainfrom
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 concise, repository-specific templates for bug reports, enhancements, good first issues, questions, and pull requests. This helps reports collect consistent AMD GPU, ROCm, AMD SMI, HAMi, runtime, and reproduction details while keeping project behavior unchanged.

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

Special notes for your reviewer:

This is a documentation-only change. The issue-template front matter was parsed locally, uses existing repository labels, and all five Markdown files were checked for whitespace errors. Diagnostic prompts request only relevant, time-bounded excerpts and require sensitive identifiers to be masked.

Does this PR introduce a user-facing change?:

Yes. Contributors will see repository-specific prompts when opening issues and pull requests.

AI Disclosure:

AI was used only for formatting purposes.

Summary by CodeRabbit

  • Documentation
    • Added structured templates for bug reports, enhancement requests, questions, and good-first issues.
    • Added a pull request template covering change type, purpose, related issues, reviewer notes, and user-facing impact.
    • Templates request relevant environment details and diagnostic information while reminding contributors to redact sensitive data.

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

hami-robot Bot commented Aug 8, 2026

Copy link
Copy Markdown

@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 concise, repository-specific templates for bug reports, enhancements, good first issues, questions, and pull requests. This helps reports collect consistent AMD GPU, ROCm, AMD SMI, HAMi, runtime, and reproduction details while keeping project behavior unchanged.

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

Special notes for your reviewer:

This is a documentation-only change. The issue-template front matter was parsed locally, uses existing repository labels, and all five Markdown files were checked for whitespace errors. Diagnostic prompts request only relevant, time-bounded excerpts and require sensitive identifiers to be masked.

Does this PR introduce a user-facing change?:

Yes. Contributors will see repository-specific prompts when opening issues and pull requests.

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

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: blackdragoon26

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

@hami-robot

hami-robot Bot commented Aug 8, 2026

Copy link
Copy Markdown

Welcome @blackdragoon26! It looks like this is your first PR to Project-HAMi/amd-device-plugin 🎉

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 54a8ccfd-7cda-40ea-8093-bbe5079fdb7b

📥 Commits

Reviewing files that changed from the base of the PR and between 808784f and 654c38e.

📒 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

📝 Walkthrough

Walkthrough

The pull request adds repository-local GitHub templates for bug reports, enhancements, good first issues, questions, and pull requests. The templates collect structured technical details and include sensitive-data redaction guidance.

Changes

Contribution templates

Layer / File(s) Summary
Issue and pull request template set
.github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md
Adds structured prompts for issue metadata, reproduction details, environment information, contributor guidance, 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 — Requests the same five repository-local issue and pull request templates.
  • Project-HAMi/volcano-vgpu-device-plugin#147 — Implements the same set of contribution templates in another repository.
  • Project-HAMi/HAMi-core#254 — Requests matching bug, enhancement, good-first-issue, question, and pull request templates.
  • Project-HAMi/HAMi#2482 — Requests an AI assistance disclosure section in the pull request template.

Suggested labels: enhancement

Poem

I’m a rabbit with templates neat,
Guiding each report to its seat.
Bugs, questions, features in line,
Pull requests marked clear and fine.
Redact the secrets, then hop away!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The five requested templates are present, but the summary does not confirm required labels or blank issue creation [#14]. Verify that the templates use the existing labels and that GitHub still permits blank issue creation.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the addition of AMD contribution templates.
Out of Scope Changes check ✅ Passed All changes add repository contribution templates requested by issue #14 and do not alter runtime behavior.
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 14:36
@coderabbitai coderabbitai Bot added the enhancement New feature or request label Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add GitHub contribution templates

1 participant