docs: add Ascend contribution templates - #124
Conversation
Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
|
@blackdragoon26: The label(s) DetailsIn response to this:
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. |
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughAdded repository-local GitHub issue templates for four issue types and a pull request template. The templates collect structured reproduction, environment, contribution, review, and disclosure details, with guidance to redact sensitive information. ChangesContribution Templates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Welcome @blackdragoon26! It looks like this is your first PR to Project-HAMi/ascend-device-plugin 🎉 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/ISSUE_TEMPLATE/enhancement.md (1)
9-14: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winMake contribution intake consistent across templates.
The templates do not consistently collect the deployment, environment, acceptance, and verification data required by the PR objectives.
.github/ISSUE_TEMPLATE/enhancement.md#L9-L14: Add affected component, deployment context, acceptance criteria, and a verification plan..github/ISSUE_TEMPLATE/question.md#L13-L21: Split installation method and slicing mode, then add image/tag, container runtime, scheduler, deployment configuration, and verification-result fields..github/PULL_REQUEST_TEMPLATE.md#L15-L26: Add tests or checks with results and a deployment/configuration impact field.🤖 Prompt for 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. In @.github/ISSUE_TEMPLATE/enhancement.md around lines 9 - 14, Make contribution intake consistent across the templates: in .github/ISSUE_TEMPLATE/enhancement.md lines 9-14, add fields for affected component, deployment context, acceptance criteria, and a verification plan; in .github/ISSUE_TEMPLATE/question.md lines 13-21, separate installation method from slicing mode and add image/tag, container runtime, scheduler, deployment configuration, and verification-result fields; in .github/PULL_REQUEST_TEMPLATE.md lines 15-26, add tests or checks with their results and a deployment/configuration impact field.
🤖 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/bug-report.md:
- Line 22: Update the kubelet log command in the bug-report template to include
explicit journalctl --since and --until bounds, while preserving the existing
reverse ordering and kubelet unit filter.
---
Outside diff comments:
In @.github/ISSUE_TEMPLATE/enhancement.md:
- Around line 9-14: Make contribution intake consistent across the templates: in
.github/ISSUE_TEMPLATE/enhancement.md lines 9-14, add fields for affected
component, deployment context, acceptance criteria, and a verification plan; in
.github/ISSUE_TEMPLATE/question.md lines 13-21, separate installation method
from slicing mode and add image/tag, container runtime, scheduler, deployment
configuration, and verification-result fields; in
.github/PULL_REQUEST_TEMPLATE.md lines 15-26, add tests or checks with their
results and a deployment/configuration impact field.
🪄 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: 9c448677-eb77-44ae-8e0b-8ec0fac3ba80
📒 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
| - Relevant Docker or containerd configuration sections. Omit credentials, tokens, passwords, private keys, certificates, and unrelated host data. | ||
| - Relevant, time-bounded excerpts from the ascend-device-plugin container logs | ||
| - Relevant, time-bounded excerpts from the HAMi scheduler or Volcano scheduler container logs | ||
| - Relevant, time-bounded excerpts from the kubelet logs on the node (e.g: `sudo journalctl -r -u kubelet`) |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
Make the kubelet example time-bounded.
journalctl -r -u kubelet filters by unit but returns the full retained journal. It does not enforce the template’s time-bounded logging requirement. Add explicit --since and --until values.
Proposed fix
-- Relevant, time-bounded excerpts from the kubelet logs on the node (e.g: `sudo journalctl -r -u kubelet`)
+- Relevant kubelet log excerpts for the incident window (e.g. `sudo journalctl -r -u kubelet --since "<start>" --until "<end>" --no-pager`)The PR objective requires time-bounded diagnostic excerpts.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Relevant, time-bounded excerpts from the kubelet logs on the node (e.g: `sudo journalctl -r -u kubelet`) | |
| - Relevant kubelet log excerpts for the incident window (e.g. `sudo journalctl -r -u kubelet --since "<start>" --until "<end>" --no-pager`) |
🤖 Prompt for 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.
In @.github/ISSUE_TEMPLATE/bug-report.md at line 22, Update the kubelet log
command in the bug-report template to include explicit journalctl --since and
--until bounds, while preserving the existing reverse ordering and kubelet unit
filter.
There was a problem hiding this comment.
I mean yeah, but would like to see maintainers idea on that, until then I would hold
There was a problem hiding this comment.
@blackdragoon26, acknowledged. Hold this change until a maintainer provides direction. The review comment remains open for now.
You are interacting with an AI system.
1 participant
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 Ascend NPU, CANN, scheduler, runtime, and reproduction details while keeping project behavior unchanged.
Which issue(s) this PR fixes:
Fixes #123
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