Skip to content

Commit

Permalink
Merge pull request #102 from cliffordfajardo/main
Browse files Browse the repository at this point in the history
add github ISSUE_TEMPLATE folder
  • Loading branch information
gabrielcsapo authored Mar 14, 2022
2 parents 42c4fb9 + 0aa9c7b commit ad0fdf8
Show file tree
Hide file tree
Showing 4 changed files with 176 additions and 5 deletions.
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: "🐛 Bug report"
title: "[BUG] - YOUR_BUG_TITLE_HERE_REPLACE_ME"
labels: [bug]
description: Create a report to help us improve
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue :pray:.
This issue tracker is for reporting bugs found in `deploy.sh` (https://github.com/gabrielcsapo/deploy.sh).
If you have a question about how to achieve something and are struggling, please post a question
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- `deploy.sh` Issues tab: https://github.com/gabrielcsapo/deploy.sh/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
- `deploy.sh` Closed issues tab: https://github.com/gabrielcsapo/deploy.sh/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
- `deploy.sh` Discussion's tab: https://github.com/gabrielcsapo/deploy.sh/discussions
The more information you fill in, the better the community can help you.
- type: textarea
id: description
attributes:
label: Describe the bug
description: Provide a clear and concise description of the challenge you are running into.
validations:
required: true
- type: input
id: link
attributes:
label: Minimal Reproduction
description: Provide a **minimal** example to reproduce the bug.
placeholder: Github Repo link
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue
description: Describe the steps we have to take to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Provide a clear and concise description of what you expected to happen.
placeholder: |
As a user, I expected ___ behavior but i am seeing ___
validations:
required: true
- type: dropdown
id: operating_system_type
attributes:
label: Operating System Type
description: What web operating system are you using?
options:
- MacOS
- Windows
- Other (please write in Additional Context)
validations:
required: true
- type: input
id: docker_version
attributes:
label: Docker Version
description: What version of Docker are you using? (_type `docker --version` in your terminal_)
placeholder: Your Node.js Version
validations:
required: true
- type: input
id: nodejs_version
attributes:
label: Node.js Version
description: What version of Node.js are you using? (_type `node --version` in your terminal_)
placeholder: Your Node.js Version
validations:
required: true
- type: input
id: deploysh_version
attributes:
label: deploy.sh Version
description: What version of deploy.sh are you using?
placeholder: deploy.sh version
validations:
required: true
- type: textarea
id: screenshots_or_videos
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Feature Requests & Questions
url: https://github.com/gabrielcsapo/deploy.sh/discussions
about: Please ask and answer questions here.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature request
title: "[Feature Request] YOUR_FEATURE_TITLE_HERE_REPLACE_ME"
labels: [feature request]
description: |
💡 Suggest an idea for the `deploy.sh` project
Examples
- propose a new component
- improve an exiting component
- ....etc
body:
- type: markdown
attributes:
value: |
This issue form is for requesting features only! For example, requesting a new component, behavior ... etc
If you want to report a bug, please use the [bug report form](https://github.com/gabrielcsapo/deploy.sh/issues/new?assignees=&labels=&template=bug_report.yml).
- type: textarea
validations:
required: true
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
- type: textarea
validations:
required: true
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: |
As a user, I expected ___ behavior but ___ ...
Ideal Steps I would like to see:
1. Go to '...'
2. Click on '....'
3. ....
- type: textarea
validations:
required: true
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
15 changes: 10 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ad0fdf8

Please sign in to comment.