8000 Add issue forms by LtDan33 · Pull Request #264 · pyscript/pyscript · GitHub
[go: up one dir, main page]

Skip to content

Add issue forms #264

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

Merged
merged 16 commits into from
May 26, 2022
Merged

Add issue forms #264

merged 16 commits into from
May 26, 2022

Conversation

LtDan33
Copy link
Contributor
@LtDan33 LtDan33 commented May 6, 2022

Addresses #255. Added some issue forms in order to help guide issues coming in. Starting with bugs and feature requests.

Thanks to @antocuni for the assist.

The following issue types were suggested in the original issue created. I'm not sure if making all of them in this initial ticket makes sense.

  • Help requests/questions
  • Bug report
  • Feature request
  • Misc

PR notes: Due to the older way of creating issue templates being in place in another PR in parallel, I rebased to be able to take those markdown files into this PR and then remove them. Otherwise, there would be two selections for bugs using yml (forms - newer) and markdown (templates - older). You can disregard changes other than the "ISSUE_TEMPLATE" folder.

Edit:

The following are intentially left out as to not create too many issues in the beginning. If the "misc" gets too big then we can separate out as needed.

@LtDan33
Copy link
Contributor Author
LtDan33 commented May 6, 2022

There are a few other types of issues that I didn't add as I want to see which makes sense to add in the beginning. Looking for feedback on what other ones are valuable without having too many. Also I think having a "miscellaneous" ticket for things that people don't think fit cleanly. I think it would be better to have them in that bucket than in a place it really doesn't belong in.

Added browsers dropdown to bugs
@LtDan33 LtDan33 self-assigned this May 6, 2022
@LtDan33 LtDan33 marked this pull request as ready for review May 6, 2022 17:10
@LtDan33 LtDan33 requested review from antocuni, fpliger and jezdez May 6, 2022 17:10
@LtDan33 LtDan33 changed the title Added bug report and feature request issue forms Add issue forms May 6, 2022
Copy link
Contributor
@antocuni antocuni left a comment

Choose a reason for hiding this comment

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

thank you the PR, I like it and I think that forms work better than the current templates.
In the meantime, @fpliger already merged my #252 so maybe he also wants to have a look to this.
Also, I don't know how the two interacts: what happens if you have both an issue templates and and issue forms? Maybe the best is to rebase this PR on top of the current master and delete the issue templates files.

Finally, an idea which just came to my mind: what about a new category called "Question", which we can use to redirect people to the nucleus forum? Something like "github issues are for bugs and feature requests, but you are welcome to ask your question there".
Hopefully this will help to avoid cluttering the issues with general questions as it is happening now

@LtDan33
Copy link
Contributor Author
LtDan33 commented May 9, 2022

@antocuni if there are both, then I believe both will be listed. Basically, all forms and templates are shown. Which would be confusing :). I'll update this PR to account for the other one.

alago1 and others added 5 commits May 17, 2022 07:42
* add enter keypress event in todo example

* fix linting

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Changed variable names to snakecase for PEP8 formatting.

* Changed variable names to snakecase for PEP8 formatting.

* fix indentation

Co-authored-by: Fabio Pliger <fabio.pliger@gmail.com>
* add issue templates

* incorporate @fpliger suggestions
@LtDan33
Copy link
Contributor Author
LtDan33 commented May 17, 2022

Updated the top-level description, but I rebased to be able to remove the other markdown issues. Otherwise, there would be duplicate issue types until another PR corrected that. This way it should be as expected once this is merged.

@antocuni
Copy link
Contributor

@LtDan33 LGTM, thank you. Sorry it took so long to review, merging it now!

@antocuni
Copy link
Contributor

merging it now!

I take it back, I just noticed that pre-commit.ci is failing, trying to fix it

antocuni added a commit to antocuni/test_issues that referenced this pull request May 25, 2022
Copy link
Contributor
@antocuni antocuni left a comment

Choose a reason for hiding this comment

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

@LtDan33 before merging, I tried to apply this changes to an empty repo but it seems it's not working as intended. See https://github.com/antocuni/test_issues , which contains a complete copy of the .github folder as present in this PR.
If you click on New issue, you see "Bug Report" and "Feature Request", but they are the one based on the old .md files, not the new issue forms.

@pww217
Copy link
Contributor
pww217 commented May 25, 2022

pre-commit seems to have an issue with the double :: near the top of the template. I'm not sure if that's intentionally part of the template here but it considers it a linting problem.

This is a common problem with adding too many things to pre-commit is that we use their default configurations and those are often painfully strict. You CAN merge this without the tests passing, but it'll probably bother us again at some future p 8000 oint. It probably was a bit rushed to add so many checks with default configs but that's where we are now.

@mattkram
Copy link
Contributor

Assuming those :: are legitimately part of the tag spec for GitHub issues templates, then we need to make them into strings. However, the Pretty format YAML hook was then removing the quotes, so I excluded the ISSUES_TEMPLATES folder from that pre-commit hook.

@LtDan33
Copy link
Contributor Author
LtDan33 commented May 26, 2022

Thanks, @mattkram! I updated those to now match the labels in this repo. Also removed the markdown files as they hadn't been deleted prior.

Thanks for the catch @antocuni . I confirmed the formater removing the quotes was the issue. All is well now. GitHub still sees you as requesting a change to merge the PR even thought the actual review shows everything as resolved. Will see if that updates itself if not you might need to manually update that on your end.

@antocuni
Copy link
Contributor

GitHub still sees you as requesting a change to merge the PR even thought the actual review shows everything as resolved.
yes, I don't know what happened. I added a new empty review as "approve" and it's merge-able now.
Also, I pushed a small commit which adds the needs-triage label to all new issues, as it was with the old .md files. I tested the new files on a test repo and they seems to work as intended. Merging the PR, this time for real :).
Thank you!

@antocuni antocuni merged commit 5d733ab into main May 26, 2022
@antocuni antocuni deleted the 255_Add-issue-forms branch May 26, 2022 21:59
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.

8 participants
0