Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: issue templates #716

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 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 ORAS Go library!
- type: textarea
id: environment
validations:
required: true
attributes:
label: What happened in your environment?
description: "Please also attach logs here using `--debug` flag."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since oras-go is a library, there is no --debug flag.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shizhMSFT can we put the description like : description: "Please also attach logs here ." ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we put the description like : description: "Please also attach logs here ." ?

This sounds good to me.

- 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 tell us your environment information as minimally and precisely as possible."
- type: textarea
id: version
validations:
required: true
attributes:
label: What is the version of your ORAS CLI?
dextrot marked this conversation as resolved.
Show resolved Hide resolved
description: "You can use the command `oras version` to get it."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, it is oras-go library, not a CLI. There is no oras version command for it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also applies to feature-request.yaml.

dextrot marked this conversation as resolved.
Show resolved Hide resolved
- type: input
id: os
validations:
required: true
attributes:
label: What is your OS environment?
description: "e.g. Ubuntu 16.04"
- 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 channel."
options:
- label: Yes, I am willing to fix it.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 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
contact_links:
- name: Ask a question or request support in the community
url: https://github.com/oras-project/oras-go/discussions
about: Ask a question or request support for using ORAS go library
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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 ORAS."
dextrot marked this conversation as resolved.
Show resolved Hide resolved
- type: input
id: version
attributes:
label: "What is the version of your ORAS CLI"
dextrot marked this conversation as resolved.
Show resolved Hide resolved
description: "You can use the command `oras version` to get it"
dextrot marked this conversation as resolved.
Show resolved Hide resolved
dextrot marked this conversation as resolved.
Show resolved Hide resolved
- 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 ORAS?"
dextrot marked this conversation as resolved.
Show resolved Hide resolved
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 channel."
options:
- label: Yes, I am willing to implement it.
Loading