-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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: Migrate to GitHub Issue Forms, improve and update contribution guidelines #11945
Merged
smolinari
merged 12 commits into
quasarframework:dev
from
yusufkandemir:chore-migrate-to-github-issue-forms
Jan 10, 2022
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
a917eea
chore: Migrate to GitHub Issue Forms
yusufkandemir bdc928d
chore: Get rid of the redundant vulnerability report template
yusufkandemir 92b1fec
chore: Reword the bug report notice
yusufkandemir 5ee9095
chore: Convert and greatly improve docs report
yusufkandemir 8cda2aa
chore: Add a mention to the Contribution Guide on the docs to issue c…
yusufkandemir 8ab2803
chore/docs: Update contribution guidelines
yusufkandemir e0e783e
chore: Update pull request template
yusufkandemir 86065f7
chore: Update 'kind' labels with emojis
yusufkandemir 025bc46
Update .github/ISSUE_TEMPLATE/bug-report--quasar-v2.yml
yusufkandemir cea93cd
Update .github/ISSUE_TEMPLATE/docs-report--quasar-v1.yml
yusufkandemir ac2039f
Update .github/ISSUE_TEMPLATE/docs-report--quasar-v2.yml
yusufkandemir 3cc17ca
Update .github/ISSUE_TEMPLATE/bug-report--quasar-v1.yml
yusufkandemir File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
name: Bug report (Quasar v1) | ||
description: Create a bug report to help us improve | ||
labels: ['kind/bug 🐞', 'Qv1'] | ||
|
||
# Note: Do NOT use commas(,) in options with 'multiple: true', the issue processing workflow won't be able to label it | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
### Read Before Proceeding Further | ||
|
||
This form is for submitting a **bug report** for Quasar Framework(**v1**). | ||
So, if you are using another version, just seeking help, or want to submit a feature request, please return back and choose a more suitable option from the list. | ||
|
||
Also, please search your issue on the repo and make sure it does not already exist. | ||
|
||
Please fill out the form correctly according to the instructions, try to be as clear as possible, and provide as many details as possible, for our team to better understand the issue and resolve it faster. | ||
Issues with an unclear description or lacking information have a lower priority. They may even get closed without taking action. | ||
|
||
Please also give a read to [Reporting an Issue | Contribution Guide](https://quasar.dev/contribution-guide/contribution-guide#reporting-an-issue) section of our docs for a more detailed explanation. | ||
|
||
Thanks for your understanding, we truly appreciate your effort to fill out this form! | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Clearly and concisely explain the problem. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: What did you expect to happen? | ||
validations: | ||
required: true | ||
- type: input | ||
id: repro-url | ||
attributes: | ||
label: Reproduction URL | ||
description: | | ||
Fork a [Codepen](https://codepen.io/rstoenescu/pen/VgQbdx) or a [jsFiddle](https://jsfiddle.net/rstoenescu/rmaodk0f) or a [Codesandbox](https://codesandbox.io/s/github/quasarframework/quasar-codesandbox/tree/legacy-v1) and hit save then copy-paste the URL here. | ||
_You can provide a GitHub repo only as a last resort. Keep in mind that it will be prioritized less as it makes the reproduction process slower._ | ||
placeholder: https://codepen.io/rstoenescu/pen/VgQbdx | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: repro-description | ||
attributes: | ||
label: How to reproduce? | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
1. Go to the provided reproduction link | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See the error | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: flavour | ||
attributes: | ||
label: Flavour | ||
description: Choose the Quasar flavour you are using. _The names between parentheses indicate the package names if applicable._ | ||
options: | ||
- Quasar CLI (@quasar/cli | @quasar/app) | ||
- UMD | ||
- Vue CLI Plugin (vue-cli-plugin-quasar) | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: areas | ||
attributes: | ||
label: Areas | ||
description: Mark the areas in which you see the problem on. _The names between parentheses indicate the package names if applicable._ | ||
multiple: true | ||
options: | ||
- Quasar CLI Commands/Configuration (@quasar/cli | @quasar/app) | ||
|
||
- Components (quasar) | ||
- Directives (quasar) | ||
- Plugins (quasar) | ||
- Style & Identity (quasar) | ||
|
||
- Quasar Extras (@quasar/extras) | ||
- TypeScript Support | ||
- App Extension API | ||
# TODO: Consider creating a separate issue template for Icon Genie CLI as most of the info requested may not be relevant | ||
- Icon Genie CLI (@quasar/icongenie) | ||
|
||
- SPA Mode | ||
- SSR Mode | ||
- PWA Mode | ||
- Electron Mode | ||
- Cordova Mode | ||
- Capacitor Mode | ||
- BEX Mode | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: Platforms/Browsers | ||
description: Mark the platforms/browsers in which you see the problem on. _If you select `Other`, please explain it in `Additional context` section._ | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- Internet Explorer 11 | ||
- iOS | ||
- Android | ||
- Electron | ||
- Other | ||
- type: textarea | ||
id: q-info | ||
attributes: | ||
label: Quasar info output | ||
description: | | ||
Please run [`quasar info` command](https://quasar.dev/quasar-cli/commands-list#info), then copy and paste the output. | ||
_This will be automatically formatted into code, so no need for backticks._ | ||
render: shell | ||
# TODO: Validate the format by using GitHub Actions, Probot, etc. | ||
# TODO: Make this required if the flavour is Quasar CLI, by using GitHub Actions, Probot, etc. | ||
# Consider adding separate controls to select important versions such as quasar, @quasar/app, vite, etc. to also respect the other flavours | ||
# or add just the 'quasar' version(to cover UMD), then evolve `quasar info` command to cover most/all cases, and make people use `npx quasar info` for the environment and package information | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: | | ||
Please copy and paste any relevant log output. | ||
_This will be automatically formatted into code, so no need for backticks._ | ||
render: shell | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me, too many "please"...