Skip to content

Commit

Permalink
docs: update issue template with contribution details (#379)
Browse files Browse the repository at this point in the history
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
  • Loading branch information
sozercan committed Oct 20, 2023
1 parent 89eddc6 commit f8af3e9
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 8 deletions.
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: Bug Report
description: Report a bug in Project Copacetic
title: "[BUG] <title>"
labels: "bug"
labels:
- "bug"
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -32,4 +33,11 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a bug report!
Thanks for taking the time to fill out a bug report!
- type: checkboxes
id: idea
attributes:
label: "Are you willing to submit PRs to contribute to this bug fix?"
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 the `#copa` channel on the [OCI Slack](https://communityinviter.com/apps/opencontainers/join-the-oci-community) if you have any questions."
options:
- label: Yes, I am willing to implement it.
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: Documentation Improvement
description: Suggest a correction or improvement in Project Copacetic documents
title: "[DOC] <title>"
labels: "documentation"
labels:
- "documentation"
body:
- type: markdown
attributes:
Expand All @@ -25,4 +26,11 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a documentation improvement!
Thanks for taking the time to suggest a documentation improvement!
- type: checkboxes
id: idea
attributes:
label: "Are you willing to submit PRs to contribute to documentation?"
description: "This is absolutely not required, but we are happy to guide you in the contribution process. Join us at the `#copa` channel on the [OCI Slack](https://communityinviter.com/apps/opencontainers/join-the-oci-community) if you have any questions."
options:
- label: Yes, I am willing to implement it.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: Question
description: Ask a question about Project Copacetic
title: "[QUESTION] <title>"
labels: "question"
labels:
- "question"
body:
- type: markdown
attributes:
Expand Down
14 changes: 11 additions & 3 deletions .github/ISSUE_TEMPLATE/request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: Request
description: Request a new feature or propose an enhancement to Project Copacetic
title: "[REQ] <title>"
labels: "enhancement"
labels:
- "enhancement"
body:
- type: markdown
attributes:
Expand All @@ -20,8 +21,15 @@ body:
label: What is your request or suggestion?
placeholder: |
e.g. I would like copa to add this <feature> so that I can use it in my <scenario>.
e.g. When using <copa command> the <current behavior> has this <limitation> and it would be better if it has this <improvement>.
e.g. When using <copa command> the <current behavior> has this <limitation> and it would be better if it has this <improvement>.
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a request!
Thanks for taking the time to fill out a request!
- type: checkboxes
id: idea
attributes:
label: "Are you willing to submit PRs to contribute to this feature request?"
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 the `#copa` channel on the [OCI Slack](https://communityinviter.com/apps/opencontainers/join-the-oci-community) if you have any questions."
options:
- label: Yes, I am willing to implement it.

0 comments on commit f8af3e9

Please sign in to comment.