Skip to content
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

Conversation

yusufkandemir
Copy link
Member

@yusufkandemir yusufkandemir commented Jan 7, 2022

What kind of change does this PR introduce?

  • Documentation
  • Triaging Improvements

Does this PR introduce a breaking change?

  • No

The PR fulfills these requirements:

  • It's submitted to the dev branch (or v[X] branch)

Other information:
This PR satisfies most parts of quasarframework/rfcs#10 in a more improved way.

Most of the labels are already updated, but the following labels need to be updated right after merging this PR to avoid unlabeled issues getting created using old issue templates:

  • "🐞 bug" -> "kind/bug 🐞"
  • "📄 docs" -> "kind/docs 📄"
  • "feature request ❔" -> "kind/feature 💡"
    • Not referenced in the code, but we will convert "graduated" feature discussions to issues and add this label

See https://github.com/yusufkandemir/github-issue-form-test to see progressive and detailed commits, inspect opened test issues, and maybe give it a try.

@hawkeye64
Copy link
Member

This looks amazing! ❤️

Comment on lines +12 to +22
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!
Copy link
Collaborator

@smolinari smolinari Jan 7, 2022

Choose a reason for hiding this comment

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

Suggested change
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!
This form is for submitting a **bug report** for Quasar Framework(**v1**).
If you are using another version, just seeking help, or you would like to submit a feature request, go back and choose a more suitable option from the list.
Also, search for your issue in the repo to be sure it doesn't exist already.
To enter your issue, fill out the form correctly and according to the instructions. Try to be as clear as possible and provide as many details as possible, to help our team better understand the issue and to resolve it faster.
Issues with an unclear description or lacking information will have a lower priority. They may even get closed without taking action.
Lastly, read the [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!

Copy link
Member

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"...

.github/ISSUE_TEMPLATE/bug-report--quasar-v1.yml Outdated Show resolved Hide resolved
Comment on lines +12 to +22
This form is for submitting a **bug report** for Quasar Framework(**v2**).
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!
Copy link
Collaborator

@smolinari smolinari Jan 7, 2022

Choose a reason for hiding this comment

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

Suggested change
This form is for submitting a **bug report** for Quasar Framework(**v2**).
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!
This form is for submitting a **bug report** for Quasar Framework(**v2**).
If you are using another version, just seeking help, or you would like to submit a feature request, go back and choose a more suitable option from the list.
Also, search for your issue in the repo to be sure it doesn't exist already.
To enter your issue, fill out the form correctly and according to the instructions. Try to be as clear as possible and provide as many details as possible, to help our team better understand the issue and to resolve it faster.
Issues with an unclear description or lacking information will have a lower priority. They may even get closed without taking action.
Lastly, read the [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!

.github/ISSUE_TEMPLATE/bug-report--quasar-v2.yml Outdated Show resolved Hide resolved
Comment on lines +12 to +22
This form is for submitting a **docs report** for Quasar Framework(**v1**). (https://v1.quasar.dev)
So, if you are using another version, want to report a bug, 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 [Contributing to the Quasar Documentation | Contribution Guide](https://v1.quasar.dev/contribution-guide/contribution-guide#contributing-to-the-quasar-documentation) section of our docs.

Thanks for your understanding, we truly appreciate your effort to fill out this form!
Copy link
Collaborator

@smolinari smolinari Jan 7, 2022

Choose a reason for hiding this comment

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

Suggested change
This form is for submitting a **docs report** for Quasar Framework(**v1**). (https://v1.quasar.dev)
So, if you are using another version, want to report a bug, 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 [Contributing to the Quasar Documentation | Contribution Guide](https://v1.quasar.dev/contribution-guide/contribution-guide#contributing-to-the-quasar-documentation) section of our docs.
Thanks for your understanding, we truly appreciate your effort to fill out this form!
This form is for submitting a **docs report** for Quasar Framework(**v1**). (https://v1.quasar.dev).
If you are using another version, just seeking help, or you would like to submit a feature request, go back and choose a more suitable option from the list.
Also, search for your issue in the repo to be sure it doesn't exist already.
To enter your issue, fill out the form correctly and according to the instructions. Try to be as clear as possible and provide as many details as possible, to help our team better understand the issue and to resolve it faster.
Issues with an unclear description or lacking information will have a lower priority. They may even get closed without taking action.
Lastly, read the [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!

.github/ISSUE_TEMPLATE/docs-report--quasar-v1.yml Outdated Show resolved Hide resolved
Comment on lines +12 to +22
This form is for submitting a **docs report** for Quasar Framework(**v2**). (https://quasar.dev)
So, if you are using another version, want to report a bug, 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 [Contributing to the Quasar Documentation | Contribution Guide](https://quasar.dev/contribution-guide/contribution-guide#contributing-to-the-quasar-documentation) section of our docs.

Thanks for your understanding, we truly appreciate your effort to fill out this form!
Copy link
Collaborator

@smolinari smolinari Jan 7, 2022

Choose a reason for hiding this comment

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

Suggested change
This form is for submitting a **docs report** for Quasar Framework(**v2**). (https://quasar.dev)
So, if you are using another version, want to report a bug, 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 [Contributing to the Quasar Documentation | Contribution Guide](https://quasar.dev/contribution-guide/contribution-guide#contributing-to-the-quasar-documentation) section of our docs.
Thanks for your understanding, we truly appreciate your effort to fill out this form!
This form is for submitting a **docs report** for Quasar Framework(**v2**). (https://quasar.dev).
If you are using another version, just seeking help, or you would like to submit a feature request, go back and choose a more suitable option from the list.
Also, search for your issue in the repo to be sure it doesn't exist already.
To enter your issue, fill out the form correctly and according to the instructions. Try to be as clear as possible and provide as many details as possible, to help our team better understand the issue and to resolve it faster.
Issues with an unclear description or lacking information will have a lower priority. They may even get closed without taking action.
Lastly, read the [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!

.github/ISSUE_TEMPLATE/docs-report--quasar-v2.yml Outdated Show resolved Hide resolved
yusufkandemir and others added 4 commits January 8, 2022 00:23
Co-authored-by: Scott <smolinari@users.noreply.github.com>
Co-authored-by: Scott <smolinari@users.noreply.github.com>
Co-authored-by: Scott <smolinari@users.noreply.github.com>
Co-authored-by: Scott <smolinari@users.noreply.github.com>
@hawkeye64
Copy link
Member

I think we can remove all instances of "please" and keep the context. A lot of languages don't have "please" and it is difficult for those languages to understand the concept. Comparatively, it translates to "Be nice and..."

@smolinari
Copy link
Collaborator

@hawkeye64 - Agreed. I removed all "pleases". And merged. Great work again @yusufkandemir

Scott

@smolinari smolinari merged commit 82d8810 into quasarframework:dev Jan 10, 2022
Copy link
Collaborator

@smolinari smolinari left a comment

Choose a reason for hiding this comment

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

Reviewed

@MilosPaunovic
Copy link
Member

MilosPaunovic commented Jan 10, 2022

This seems like the first isssue created with new form #11967

And it does look good!

@yusufkandemir
Copy link
Member Author

@MilosPaunovic well, actually everything about it isn't looking good 😅
There were some weird problems with template labels(kind/bug 🐞, Qv2 🔝, etc.) which are used to identify the type and version of the issue. That issue doesn't have any labels at all, which caused the GitHub Actions workflow to skip over the issue.
They are now fixed, and hopefully, the workflow will label the issue according to user input, send some comments to warn the user if there is something wrong, etc.

Thanks for implicitly letting us know about the issue 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants