Issue templates (#17)
* Inital draft for issue templates * pull request template Co-authored-by: t-dedah <t-dedah@github.com>
This commit is contained in:
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
name: "\U0001F41B Bug report"
|
||||
about: Report a bug or unexpected behavior while using GitHub Actions Cache CLI extension
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
|
||||
A clear and concise description of what the bug is. Include CLI version by typing `gh actions-cache --version` and extension version by typing `gh actions-cache --version`. <!--TODO: Implement version printing for the cache -->
|
||||
|
||||
### Steps to reproduce the behavior
|
||||
|
||||
1. Execute this command '...'
|
||||
2. View the output '....'
|
||||
3. See error
|
||||
|
||||
### Expected vs actual behavior
|
||||
|
||||
A clear and concise description of what you expected to happen and what actually happened.
|
||||
|
||||
### Logs
|
||||
|
||||
Paste the activity from your command line. Redact if needed.
|
||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Ask a question on how to use GitHub CLI
|
||||
about: For general-purpose questions and answers, see the Discussions section.
|
||||
url: https://github.com/cli/cli/discussions
|
||||
- name: Ask a question on how to use GitHub Actions Cache CLI extension
|
||||
about: For general-purpose questions and answers for Cache CLI extension, see the Discussions section.
|
||||
url: https://github.com/actions/gh-actions-cache/discussions #TODO - Enable discussions once went public.
|
||||
- name: Ask a question about the GitHub Actions Cache API
|
||||
about: Please check out the GitHub community forum for discussions about the GitHub Actions Cache API.
|
||||
url: https://github.com/actions/cache/discussions
|
||||
28
.github/ISSUE_TEMPLATE/feedback.md
vendored
Normal file
28
.github/ISSUE_TEMPLATE/feedback.md
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
name: "\U0001F4E3 Feedback"
|
||||
about: Give us general feedback about the GitHub Actions Cache CLI extension
|
||||
title: ''
|
||||
labels: feedback
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# CLI Feedback
|
||||
|
||||
You can use this template to give us structured feedback or just wipe it and leave us a note. Thank you!
|
||||
|
||||
## What have you loved?
|
||||
|
||||
_eg "the nice colors"_
|
||||
|
||||
## What was confusing or gave you pause?
|
||||
|
||||
_eg "it did something unexpected"_
|
||||
|
||||
## Are there features you'd like to see added?
|
||||
|
||||
_eg "gh actions-cache cli extension needs colours and tables"_
|
||||
|
||||
## Anything else?
|
||||
|
||||
_eg "have a nice day"_
|
||||
20
.github/ISSUE_TEMPLATE/submit-a-request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/submit-a-request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: "⭐ Submit a request"
|
||||
about: Surface a feature or problem that you think should be solved
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Describe the feature or problem you’d like to solve
|
||||
|
||||
A clear and concise description of what the feature or problem is.
|
||||
|
||||
### Proposed solution
|
||||
|
||||
How will it benefit Actions Cache CLI extension and its users?
|
||||
|
||||
### Additional context
|
||||
|
||||
Add any other context like screenshots or mockups are helpful, if applicable.
|
||||
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
### What are you trying to accomplish?
|
||||
|
||||
<!-- Provide a description of the changes, including any screenshots, videos, or graphs if applicable. Link to any related issues or projects here. -->
|
||||
|
||||
### What approach did you choose and why?
|
||||
|
||||
<!-- This section is a place for you to describe your thought process in making these changes. List any tradeoffs you made to take on or pay down tech debt. Identify any work you did to mitigate risk. Describe any alternative approaches you considered and why you discarded them. -->
|
||||
|
||||
### Anything you want to highlight for special attention from reviewers?
|
||||
|
||||
<!-- This is your chance to identify remaining risks and confess any uncertainties you may have about the correctness of the changes. Highlight anything on which you would like a second (or third) opinion. -->
|
||||
Reference in New Issue
Block a user