Skip to content

Commit

Permalink
docs: add issue templates (#71)
Browse files Browse the repository at this point in the history
Resolves #65

Signed-off-by: Shiwei Zhang <[email protected]>
  • Loading branch information
shizhMSFT authored Dec 20, 2023
1 parent 1112cf8 commit d293a60
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Copyright The ORAS 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.

name: Bug Report
description: File a bug report
labels: [bug, triage]
body:
- type: markdown
id: preface
attributes:
value: Thank you for reporting bugs to the ORAS .NET library!
- type: textarea
id: environment
validations:
required: true
attributes:
label: What happened in your code base?
- type: textarea
id: expect
attributes:
label: What did you expect to happen?
- type: textarea
id: reproduce
validations:
required: true
attributes:
label: How can we reproduce it?
description: Please provide related code as minimally and precisely as possible.
- type: textarea
id: version
validations:
required: true
attributes:
label: What is the version or commit of the ORAS .NET library?
- type: input
id: env
validations:
required: true
attributes:
label: What are your OS and Runtime environments?
description: "e.g. Ubuntu 22.04 and .NET 8.0"
- type: checkboxes
id: idea
attributes:
label: Are you willing to submit PRs to fix it?
description: "This is absolutely not required, but we are happy to guide you in the contribution process
especially when you already have a good proposal or understanding of how to implement it. Join us at https://slack.cncf.io/ and choose #oras-dotnet channel."
options:
- label: Yes, I am willing to fix it.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Copyright The ORAS 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.

blank_issues_enabled: true
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Copyright The ORAS 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.

name: Feature Request
description: File a feature request
labels: [enhancement, triage]
body:
- type: markdown
id: preface
attributes:
value: Thank you for submitting new features for the ORAS .NET library
- type: input
id: version
attributes:
label: What is the version or commit of the ORAS .NET library?
- type: textarea
id: description
attributes:
label: What would you like to be added?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Why is this needed for the ORAS .NET library?
description: Please describe your user story or scenario.
validations:
required: true
- type: checkboxes
id: idea
attributes:
label: Are you willing to submit PRs to contribute to this feature?
description: "This is absolutely not required, but we are happy to guide you in the contribution process
especially when you already have a good proposal or understanding of how to implement it. Join us at https://slack.cncf.io/ and choose #oras-dotnet channel."
options:
- label: Yes, I am willing to implement it.

0 comments on commit d293a60

Please sign in to comment.