Skip to content

Commit

Permalink
improve issues/PRs
Browse files Browse the repository at this point in the history
Signed-off-by: juliusvonkohout <45896133+juliusvonkohout@users.noreply.github.com>
  • Loading branch information
juliusvonkohout committed Feb 10, 2025
1 parent 2cbbde3 commit fe76257
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 36 deletions.
6 changes: 1 addition & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,4 @@ contact_links:
about: Join our CNCF Slack Channel and access Kubeflow community meetings.
- name: Our channel on the CNCF Slack is kubeflow-platform.
url: https://app.slack.com/client/T08PSQ7BQ/C073W572LA2
about: You can join our channel on the CNCF slack.




about: You can join our channel on the CNCF slack.
35 changes: 17 additions & 18 deletions .github/ISSUE_TEMPLATE/issue-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ body:
- type: markdown
attributes:
value: |
Fill out the sections below to help everyone identify and fix the bug
Please provide the following details to help us diagnose and fix the issue effectively.
- type: markdown
attributes:
value: |
Follow the [Kubeflow installation guidelines](https://github.com/kubeflow/manifests/blob/master/README.md).
Follow the [Kubeflow installation guidelines](https://github.com/kubeflow/manifests/blob/master/README.md) before submitting the report.
- type: checkboxes
id: Vaildation
attributes:
label: Validation Checklist
options:
- label: Is this a Kubeflow issue?
- label: I confirm that this is a Kubeflow-related issue.
required: true

Check warning on line 18 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

18:17 [truthy] truthy value should be one of [off, on]
- label: Are you posting in the right repository ?
- label: I am reporting this in the appropriate repository.
required: true

Check warning on line 20 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

20:17 [truthy] truthy value should be one of [off, on]
- label: Did you follow the [Kubeflow installation guideline](https://github.com/kubeflow/manifests/blob/master/README.md) ?
- label: I have followed the [Kubeflow installation guidelines](https://github.com/kubeflow/manifests/blob/master/README.md).
required: true

Check warning on line 22 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

22:17 [truthy] truthy value should be one of [off, on]
- label: Is the issue report properly structured and detailed with version numbers?
- label: The issue report is detailed and includes version numbers where applicable.
required: true

Check warning on line 24 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

24:17 [truthy] truthy value should be one of [off, on]
- label: Is this for Kubeflow development ?
- label: This issue pertains to Kubeflow development.
required: false

Check warning on line 26 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

26:17 [truthy] truthy value should be one of [off, on]
- label: Would you like to work on this issue?
- label: I am available to work on this issue.
required: false

Check warning on line 28 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

28:17 [truthy] truthy value should be one of [off, on]
- label: You can join the CNCF Slack and access our meetings at the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) website. Our channel on the CNCF Slack is here [**#kubeflow-platform**](https://app.slack.com/client/T08PSQ7BQ/C073W572LA2).
required: false

Check warning on line 30 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

30:17 [truthy] truthy value should be one of [off, on]
Expand All @@ -41,27 +41,26 @@ body:
- type: textarea
id: description
attributes:
label: Describe your issue
placeholder: When installing Kubeflow I got the following error message from ...
label: Detailed Description
placeholder: Provide a clear description of the issue and its impact.
validations:
required: true

Check warning on line 47 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

47:15 [truthy] truthy value should be one of [off, on]
- type: textarea
id: steps
attributes:
label: Steps to reproduce the issue
label: Steps to Reproduce
placeholder: |
1. Try this ...
2. Then do this ...
1. Describe the initial setup.
2. Detail the steps leading to the issue.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Put here any screenshots or videos (optional)
label: Screenshots or Videos (Optional)
- type: markdown
attributes:
value: |
> **Note:** Please note that you have to fill required fields to post an issue.
If not please close or redo the issue and you can join the CNCF slack and access our meetings at the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) website. Our channel on the CNCF Slack is here [**#kubeflow-platform**](https://app.slack.com/client/T08PSQ7BQ/C073W572LA2).
**Thanks for reporting this issue! We will get back to you as soon as possible.**
> **Note:** All required fields must be completed before submitting your report.

Check failure on line 65 in .github/ISSUE_TEMPLATE/issue-report.yml

View workflow job for this annotation

GitHub Actions / format_YAML_files

65:1 [trailing-spaces] trailing spaces
Thank you for your contribution.
26 changes: 13 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Pull Request Template for Kubeflow manifests Issues
# Pull Request Template for Kubeflow Manifests

## ✏️ A brief description of the changes
> I changed ...
## ✏️ Summary of Changes
> Describe the changes you have made, including any refactoring or feature additions.
## 📦 List any dependencies that are required for this change
> My PR depends on #
## 📦 Dependencies
> List any dependencies or related PRs (e.g., "Depends on #123").
## 🐛 If this PR is related to an issue, please put the link to the issue here.
> The following issues are related, because ...
## 🐛 Related Issues
> Link any issues that are resolved or affected by this PR.
## ✅ Contributor checklist
- Make sure you have tested with kustomize. See [Installation Prerequisites](https://github.com/kubeflow/manifests#prerequisites)
- All the commits have been [_signed-off_](https://github.com/kubeflow/community/tree/master/dco-signoff-hook#signing-off-commits) (To pass the `DCO` check)
## ✅ Contributor Checklist
- [ ] I have tested these changes with kustomize. See [Installation Prerequisites](https://github.com/kubeflow/manifests#prerequisites).
- [ ] All commits are [_signed-off_](https://github.com/kubeflow/community/tree/master/dco-signoff-hook#signing-off-commits) to satisfy the DCO check.

---

---

> You can join the CNCF Slack and access our meetings at the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) website. Our channel on the CNCF Slack is here [**#kubeflow-platform**](https://app.slack.com/client/T08PSQ7BQ/C073W572LA2).

0 comments on commit fe76257

Please sign in to comment.