From 818673e1d90d150818f6457ea14313af11828112 Mon Sep 17 00:00:00 2001 From: Larry Chen Date: Wed, 15 Apr 2026 15:06:17 +0800 Subject: [PATCH] docs: add CODE_OF_CONDUCT, issue templates, and PR template Based on NVIDIA PLC-OSS-Template with project-specific customizations. Co-Authored-By: Claude Opus 4.6 --- .github/ISSUE_TEMPLATE/bug_report_form.yml | 74 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../documentation_request_form.yml | 65 ++++++++++++++ .../ISSUE_TEMPLATE/feature_request_form.yml | 86 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 9 ++ CODE_OF_CONDUCT.md | 84 ++++++++++++++++++ 6 files changed, 323 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report_form.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_request_form.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request_form.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report_form.yml b/.github/ISSUE_TEMPLATE/bug_report_form.yml new file mode 100644 index 0000000..2d80bde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_form.yml @@ -0,0 +1,74 @@ +# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Bug Report +description: File a bug report +title: "[BUG]: " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: input + id: version + attributes: + label: Version + description: What version of dsx-github-actions are you running? + placeholder: "example: v0.1.0" + validations: + required: true + + - type: textarea + id: description + attributes: + label: Describe the bug. + description: Also tell us, what did you expect to happen? + placeholder: XYZ occurred, I expected QRS results + validations: + required: true + + - type: textarea + id: mvr + attributes: + label: Minimum reproducible example + description: Please supply a minimum reproducible example here + render: shell + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please paste relevant error and log output here + render: shell + + - type: textarea + id: misc + attributes: + label: Other/Misc. + description: Please enter any other helpful information here. + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/dsx-github-actions/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow dsx-github-actions's Code of Conduct + required: true + - label: I have searched the [open bugs](https://github.com/NVIDIA/dsx-github-actions/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..30d4e37 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Ask a Question + url: https://github.com/NVIDIA/dsx-github-actions/discussions + about: Please ask any questions here. diff --git a/.github/ISSUE_TEMPLATE/documentation_request_form.yml b/.github/ISSUE_TEMPLATE/documentation_request_form.yml new file mode 100644 index 0000000..ce2b572 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request_form.yml @@ -0,0 +1,65 @@ +# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Documentation Request +description: Request corrections or additions to documentation +title: "[DOC]: " +labels: ["doc"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to improve our documentation! + + - type: dropdown + id: criticality + attributes: + label: How would you describe the priority of this documentation request + options: + - Critical (currently preventing usage) + - High + - Medium + - Low (would be nice) + validations: + required: true + + - type: input + id: location + attributes: + label: Please provide a link or source to the relevant docs + placeholder: "ex: https://github.com/NVIDIA/dsx-github-actions/blob/main/README.md" + + - type: textarea + id: problem + attributes: + label: Describe the issue or missing documentation + placeholder: The documentation says X but the actual behavior is Y + validations: + required: true + + - type: textarea + id: correction + attributes: + label: (Optional) Propose a correction or addition + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/dsx-github-actions/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow dsx-github-actions's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request_form.yml b/.github/ISSUE_TEMPLATE/feature_request_form.yml new file mode 100644 index 0000000..eeb01bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_form.yml @@ -0,0 +1,86 @@ +# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Feature Request +description: Request new or improved functionality or changes to existing functionality +title: "[FEA]: " +labels: ["feature request"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + + - type: dropdown + id: new_or_improvement + attributes: + label: Is this a new feature, an improvement, or a change to existing functionality? + options: + - New Feature + - Improvement + - Change + validations: + required: true + + - type: dropdown + id: criticality + attributes: + label: How would you describe the priority of this feature request + options: + - Critical (currently preventing usage) + - High + - Medium + - Low (would be nice) + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Please provide a clear description of the problem this feature solves + description: Real usage examples are especially helpful. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe your ideal solution + description: Please describe the functionality you would like added. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe any alternatives you have considered + + - type: textarea + id: misc + attributes: + label: Additional context + description: Add any other context or references about the feature request here. + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/dsx-github-actions/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow dsx-github-actions's Code of Conduct + required: true + - label: I have searched the [open feature requests](https://github.com/NVIDIA/dsx-github-actions/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22) and have found no duplicates for this feature request + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c7fc5ca --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +## Description + + + + +## Checklist +- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/dsx-github-actions/blob/main/CONTRIBUTING.md). +- [ ] New or existing tests cover these changes. +- [ ] The documentation is up to date with these changes. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..67e94d0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,84 @@ +# Contributor Covenant Code of Conduct + +## Overview + +Define the code of conduct followed and enforced for dsx-github-actions. + +### Intended audience + +Community | Developers | Project Leads + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting GitHub_Conduct@nvidia.com. All complaints will be reviewed and +investigated and will result in a response that is deemed necessary and appropriate +to the circumstances. The project team is obligated to maintain confidentiality with +regard to the reporter of an incident. Further details of specific enforcement policies +may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq