Skip to content

Commit

Permalink
[add] GitHub issue forms & repository settings
Browse files Browse the repository at this point in the history
[add] VS Code & GitPod.io extensions & badge
[add] Best Practice section in Read Me document
[migrate] use Nav component of latest BootCell v2
  • Loading branch information
TechQuery committed Jan 13, 2024
1 parent 4c1eb21 commit ec9812b
Show file tree
Hide file tree
Showing 12 changed files with 528 additions and 57 deletions.
187 changes: 187 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-developer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
name: 🐛 Developer Bug report
description: File a Code bug/issue
title: <title>
labels:
- bug
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true

- type: dropdown
id: system
attributes:
label: On which operating system are you experiencing the problem?
multiple: true
options:
- BSD
- Linux
- Windows
- MacOS
- iOS
- Android
validations:
required: true

- type: input
id: system-version
attributes:
label: The version of your Operation System
validations:
required: true

- type: dropdown
id: subsystem
attributes:
label: What subsystem is the problem related to?
multiple: true
options:
- Docker
- WSL
- WINE

- type: input
id: subsystem-version
attributes:
label: The version of your Sub-system

- type: dropdown
id: Web-browser
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
- Brave
- Arc Browser
- UC Browser
validations:
required: true

- type: input
id: Web-browser-version
attributes:
label: The version of your Web browser
validations:
required: true

- type: dropdown
id: network-region
attributes:
label: What network region are you in?
multiple: true
options:
- Global
- China mainland
validations:
required: true

- type: dropdown
id: cli
attributes:
label: Which command line terminal are you using?
multiple: true
options:
- Shell
- CMD
- Powershell
validations:
required: true

- type: input
id: cli-version
attributes:
label: The version of your Command-line Terminal

- type: dropdown
id: JavaScript-runtime
attributes:
label: Which JavaScript runtime are you using?
multiple: true
options:
- Node.js
- Bun
- Deno
validations:
required: true

- type: input
id: JavaScript-runtime-version
attributes:
label: The version of your JavaScript runtime
validations:
required: true

- type: dropdown
id: JavaScript-package-manager
attributes:
label: Which JavaScript package manager are you using?
multiple: true
options:
- npm
- Yarn
- pnpm
- Bun
validations:
required: true

- type: input
id: JavaScript-package-manager-version
attributes:
label: The version of your JavaScript package manager
validations:
required: true

- type: dropdown
id: development_environment
attributes:
label: Which development environment are you using?
multiple: true
options:
- Local
- Gitpod
- GitHub Codespaces
validations:
required: true

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
131 changes: 131 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
name: 🐛 User Bug report
description: File an UI bug/issue
title: <title>
labels:
- bug
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true

- type: dropdown
id: hardware
attributes:
label: What kind of hardware did the bug occur on?
multiple: true
options:
- Desktop
- Pad
- Phone
- Smart Device
- Car
validations:
required: true

- type: dropdown
id: system
attributes:
label: On which operating system are you experiencing the problem?
multiple: true
options:
- BSD
- Linux
- Windows
- MacOS
- iOS
- Android
validations:
required: true

- type: input
id: system-version
attributes:
label: The version of your Operation System
validations:
required: true

- type: dropdown
id: Web-browser
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
- Brave
- Arc Browser
- UC Browser
validations:
required: true

- type: input
id: Web-browser-version
attributes:
label: The version of your Web browser
validations:
required: true

- type: dropdown
id: network-connection
attributes:
label: What kind of network are you connecting to?
multiple: true
options:
- WLAN
- WiFi
- 4G
- 5G
validations:
required: true

- type: dropdown
id: network-region
attributes:
label: What network region are you in?
multiple: true
options:
- Global
- China mainland
validations:
required: true

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: ✨ Feature/Enhancement
description: Request a new feature or enhancement
title: <title>
labels:
- enhancement
body:
- type: checkboxes
attributes:
label: Is there an existing feature request for this?
description: Please search to see if a feature request already exists for the enhancement you are proposing.
options:
- label: I have searched the existing feature requests
required: true

- type: textarea
attributes:
label: Description
description: |
A detailed description of the new feature or enhancement you are proposing. Additionally, provide any relevant
links, references, or attachments to offer more context about the proposal. You can also attach images or other
files by clicking this area to highlight it and then dragging files in.
Tip: You can attach images or other files by clicking this area to highlight it and then dragging files in.
validations:
required: true

- type: textarea
attributes:
label: Use Case
description: Provide a use case or scenario where this feature or enhancement would be beneficial.

- type: textarea
attributes:
label: Proposed Solution
description: If you have a specific solution in mind, please describe it here.
Loading

1 comment on commit ec9812b

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for web-cell-scaffold ready!

✅ Preview
https://web-cell-scaffold-bwrjq7gs9-techquery.vercel.app

Built with commit ec9812b.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.