diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000..6ae5356 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,61 @@ +# Copyright The Ratify Authors. +# 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. + +# template created based on verbiage from https://github.com/notaryproject/notation-go/blob/v1.2.1/.github/ISSUE_TEMPLATE/bug-or-issue.yaml +name: 🐛 Bug or Issue +description: Something is not working as expected or not working at all! Report it here! +labels: [bug, triage] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this issue report. 🛑 Please check existing issues first before continuing: https://github.com/ratify-project/ratify-go/issues + - type: textarea + id: verbatim + validations: + required: true + attributes: + label: "What is not working as expected?" + description: "In your own words, describe what the issue is." + - type: textarea + id: expect + validations: + required: true + attributes: + label: "What did you expect to happen?" + description: "A clear and concise description of what you expected to happen." + - type: textarea + id: reproduce + validations: + required: true + attributes: + label: "How can we reproduce it?" + description: "Detailed steps to reproduce the behavior, code snippets are welcome." + - type: textarea + id: environment + validations: + required: true + attributes: + label: Describe your environment + description: "OS and Golang version" + - type: textarea + id: version + validations: + required: true + attributes: + label: What is the version of your ratify-go library? + description: "Check the `go.mod` file for the library version." + - type: markdown + attributes: + value: | + If you want to contribute to this project, we will be happy to guide you through the contribution process especially when you already have a good proposal or understanding of how to fix this issue. Join us at https://slack.cncf.io/ and choose #ratify channel. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a652391 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,19 @@ +# Copyright The Ratify Authors. +# 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. + +# Template created based on verbiage from https://github.com/notaryproject/notation-go/blob/v1.2.1/.github/ISSUE_TEMPLATE/config.yml +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://slack.cncf.io/ + about: "Join #ratify channel on CNCF Slack" diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 0000000..66371b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,54 @@ +# Copyright The Ratify Authors. +# 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. + +# Template created based on verbiage from https://github.com/notaryproject/notation-go/blob/v1.2.1/.github/ISSUE_TEMPLATE/feature-request.yaml +name: 🚀 Feature Request +description: Suggest an idea for this project. +labels: [enhancement, triage] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to suggest a useful feature for the project! + - type: textarea + id: problem + validations: + required: true + attributes: + label: "Is your feature request related to a problem?" + description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" + - type: textarea + id: solution + validations: + required: true + attributes: + label: "What solution do you propose?" + description: "A clear and concise description of what you want to happen." + - type: textarea + id: alternatives + validations: + required: true + attributes: + label: "What alternatives have you considered?" + description: "A clear and concise description of any alternative solutions or features you've considered." + - type: textarea + id: context + validations: + required: false + attributes: + label: "Any additional context?" + description: "Add any other context or screenshots about the feature request here." + - type: markdown + attributes: + value: | + If you want to contribute to this project, we will be happy to guide you through the contribution process especially when you already have a good proposal or understanding of how to improve the functionality. Join us at https://slack.cncf.io/ and choose #ratify channel.