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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bug form #19913

Merged
merged 21 commits into from Aug 4, 2022
Merged

Add bug form #19913

merged 21 commits into from Aug 4, 2022

Conversation

juancarlospaco
Copy link
Collaborator

@juancarlospaco juancarlospaco commented Jun 20, 2022

I changed the existing template in the repo to a GitHub issue form, just 2 YAML.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

Just improving the UX and making things easier for the users. 馃檪

@juancarlospaco juancarlospaco changed the title Add bug Add bug form Jun 20, 2022
@juancarlospaco juancarlospaco marked this pull request as ready for review June 20, 2022 16:45
@ringabout
Copy link
Member

ringabout commented Jun 20, 2022

Thanks for your hard work! I think there are too many required selections. Collecting info regarding "Where are you from" doesn't seem necessary (anyway, using continent instead of country and Region could be better).

@juancarlospaco
Copy link
Collaborator Author

juancarlospaco commented Jun 20, 2022

Collecting info regarding "Where are you from" doesn't seem necessary.

I prefer to ask the user (if they want to reply) than adding user-tracking to Nim:

@konsumlamm
Copy link
Contributor

Thanks for your hard work! I think there are too many required selections. Collecting info regarding "Where are you from" doesn't seem necessary (anyway, using continent instead of country and Region could be better).

I agree. I don't see how disk storage, memory capacity, CPU cores, internet connection, web browser are relevant either. For most bug reports, it just creates useless clutter in the issue report and in the few cases where that information is relevant, I think we can expect the creator to include that information.

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
juancarlospaco and others added 9 commits June 20, 2022 10:25
Co-authored-by: Yardanico <tiberiumk12@gmail.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
@juancarlospaco
Copy link
Collaborator Author

juancarlospaco commented Jun 20, 2022

I think we can expect the creator to include that information.

I think the problem usually is that bug reports have too scarce information,
bug reports with too much information is not a very frequent problem.

As a dev myself I think it is very useful,
example if the user says uses Linux, you can just reply with Bash commands to fix it,
if the user says 32bit Windows maybe the hardware is too old for the software, etc,
gives more context of the problem, instead of the typical "shit wont work lol" kind of reports.

You can just not fill it in anyway... 馃し

@Araq
Copy link
Member

Araq commented Jun 21, 2022

You can just not fill it in anyway... 馃し

You can also just not fill in a bug report if the task appears to be overwhelming...

@juancarlospaco
Copy link
Collaborator Author

You can also just not fill in a bug report

I agree, sending a PR instead is also an alternative, as the current template suggests too.

@Araq
Let me know what do you want to remove or add to the form.

@Araq
Copy link
Member

Araq commented Jun 21, 2022

I don't understand it, your screenshot is about RFCs, not about bug reports.

@juancarlospaco
Copy link
Collaborator Author

juancarlospaco commented Jun 21, 2022

your screenshot is about RFCs, not about bug reports.

True, I removed the screenshots.

It is similar to the one on the RFC repo, but for this repo,
I added fields to the form for info that may be useful for devs to get more context of the bug,
but it is easy to remove the fields, no problem,
it is flexible to whatever you think a bug report form should look like,
what do you want to know when you read a bug report ?

@ringabout
Copy link
Member

ringabout commented Jun 22, 2022

@juancarlospaco
Copy link
Collaborator Author

Here is the preview

Thanks @xflywind thats a lot more direct lol 馃檪:+1:

@juancarlospaco
Copy link
Collaborator Author

@Araq
Any blockers to merge this?, it is not even code, so should be easy to merge,
if some field needs to be removed let me know, any user can improve it later anyways.

@Araq Araq merged commit 2f3980f into nim-lang:devel Aug 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2022

Thanks for your hard work on this PR!
The lines below are statistics of the Nim compiler built from 2f3980f

Hint: mm: orc; threads: on; opt: speed; options: -d:release
163582 lines; 12.474s; 841.172MiB peakmem

@juancarlospaco juancarlospaco deleted the bugform branch August 4, 2022 12:53
capocasa pushed a commit to capocasa/Nim that referenced this pull request Mar 31, 2023
* Add Bug Form

* Add Bug Form

* Add Bug Form

* Add Bug Form

* nim-lang#19913 (comment)

* nim-lang#19913 (comment)

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Yardanico <tiberiumk12@gmail.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/feature_request.yml

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/feature_request.yml

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Do not Star Nim on Github

* No backwards compat problems

* Typo

Co-authored-by: Yardanico <tiberiumk12@gmail.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
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.

None yet

5 participants