diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3be45fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,82 @@ +name: Bug Report +description: Create a report to help us improve +title: "[name of the chart e.g. clearml-agent] Issue Title" +labels: [bug] +assignees: + - valeriano-manassero +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please be cautious with the sensitive information/logs while filing the issue. + - type: textarea + id: desc + attributes: + label: Describe the bug a clear and concise description of what the bug is. + validations: + required: true + - type: input + id: helm-version + attributes: + label: What's your helm version? + description: Enter the output of `$ helm version` + placeholder: Copy paste the entire output of the above + validations: + required: true + - type: input + id: kubectl-version + attributes: + label: What's your kubectl version? + description: Enter the output of `$ kubectl version` + validations: + required: true + - type: input + id: chart-version + attributes: + label: What's the chart version? + description: Enter the version of the chart that you encountered this bug. + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Enter exactly what happened. + validations: + required: false + - type: textarea + id: what-expected + attributes: + label: What you expected to happen? + description: Enter what you expected to happen. + validations: + required: false + - type: textarea + id: how-to-reproduce + attributes: + label: How to reproduce it? + description: As minimally and precisely as possible. + validations: + required: false + - type: textarea + id: changed-values + attributes: + label: Enter the changed values of values.yaml? + description: Please enter only values which differ from the defaults. Enter `NONE` if nothing's changed. + placeholder: 'key: value' + validations: + required: false + - type: textarea + id: helm-command + attributes: + label: Enter the command that you execute and failing/misfunctioning. + description: Enter the command as-is as how you executed. + placeholder: helm install my-release prometheus-community/name-of-chart --version version --values values.yaml + validations: + required: true + - type: textarea + id: anything-else + attributes: + label: Anything else we need to know? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..7a2dde4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature request +description: Suggest an idea for this project +title: "[name of the chart e.g. clearml-agent] Issue Title" +labels: [enhancement] +assignees: + - valeriano-manassero +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: desc + attributes: + label: Is your feature request related to a problem ? + description: Give a clear and concise description of what the problem is. + placeholder: ex. I'd like to have [...] + validations: + required: true + - type: textarea + id: prop-solution + attributes: + label: Describe the solution you'd like. + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. If nothing, please enter `NONE` + validations: + required: true + - type: textarea + id: additional-ctxt + attributes: + label: Additional context. + description: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d286dfc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +**What this PR does / why we need it**: + + +**Checklist** +- [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/allegroai/clearml-helm-charts/blob/main/CONTRIBUTING.md#pull-requests) guide (**required**) +- [ ] Verify the work you plan to merge addresses an existing [issue](https://github.com/allegroai/clearml-helm-charts/issues) (If not, open a new one) (**required**) +- [ ] Check your branch with `helm lint` (**required**) +- [ ] Update `version` in `Chart.yaml` according [semver](https://semver.org/) rules (**required**) +- [ ] Substitute `annotations` section in `Chart.yaml` annotating implementations (useful for Artifecthub changelog) (**required**) +- [ ] Update chart README using [helm-docs](https://github.com/norwoodj/helm-docs) (**required**) + + +**Which issue(s) this PR fixes**: + +Fixes # + +**Special notes for your reviewer**: +