KEMBAR78
Refactor issues with yaml by LysandreJik · Pull Request #16772 · huggingface/transformers · GitHub
Skip to content

Refactor issues with yaml #16772

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Apr 18, 2022
Merged

Refactor issues with yaml #16772

merged 7 commits into from
Apr 18, 2022

Conversation

@LysandreJik
Copy link
Member

This PR:

  • Refactors the issue templates using the newly introduced YAML issues.
  • Introduces a config.yml for issues which enables a redirect to the forum
  • Removes the benchmarking issue which has not been used at all and introduces noise in the issue selection process. With its removal, I'm aiming for a lower number of blank issues.

See below for the comparison across issues. To see the issue templates yourself and play with the config.yml, head over to my fork.

Old New
Bug report (MD) Bug report (YML)
image image
Old feature request New feature request
image image

The new index will now contain additional links, including a link to the forum:

image

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 13, 2022 •
edited
Loading

The documentation is not available anymore as the PR was closed or merged.

@ydshieh
Copy link
Collaborator

ydshieh commented Apr 14, 2022 •
edited
Loading

Thanks!

For the new bug report screenshot, looks like the section Who can help is not editable?

The new layout looks good! I would like to have a section 'Code Snippet' if it is not in the new layout yet. 🙂 (Haven't really tried it yet, just looking the screenshots)

patil-suraj
patil-suraj approved these changes Apr 14, 2022
View reviewed changes
Copy link
Contributor

@patil-suraj patil-suraj left a comment

Choose a reason for hiding this comment

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

Love this new YAML issues, thanks a lot for adding this @LysandreJik ! Hopefully no more bug reports without reproducible steps :)

sgugger
sgugger approved these changes Apr 14, 2022
View reviewed changes
Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

anton-l
anton-l reviewed Apr 14, 2022
View reviewed changes
Copy link
Member

@anton-l anton-l left a comment

Choose a reason for hiding this comment

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

Looks great! 😍

sanchit-gandhi
sanchit-gandhi reviewed Apr 15, 2022
View reviewed changes
Copy link
Contributor

@sanchit-gandhi sanchit-gandhi left a comment

Choose a reason for hiding this comment

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

This is amazing, looks super clean! Thank you @LysandreJik!

.github/ISSUE_TEMPLATE/migration.yml
@@ -0,0 +1,70 @@
name: "\U0001F4DA Migration from pytorch-pretrained-bert or pytorch-transformers"
description: Report a problem when migrating from pytorch-pretrained-bert or pytorch-transformers to transformers
labels: [ "migration" ]
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above regarding the label 'migration' appearing under 'migration from...' like 'bug' in 'bug report'.

patrickvonplaten
patrickvonplaten reviewed Apr 18, 2022
View reviewed changes
patrickvonplaten
patrickvonplaten reviewed Apr 18, 2022
View reviewed changes
patrickvonplaten
patrickvonplaten approved these changes Apr 18, 2022
View reviewed changes
Copy link
Contributor

@patrickvonplaten patrickvonplaten left a comment

Choose a reason for hiding this comment

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

Much nicer indeed!

LysandreJik and others added 6 commits April 18, 2022 16:34
@LysandreJik @anton-l
Update .github/ISSUE_TEMPLATE/bug-report.yml
e09d35b 
Co-authored-by: Anton Lozhkov <aglozhkov@gmail.com>
@LysandreJik @anton-l
Update .github/ISSUE_TEMPLATE/bug-report.yml
6ba1d47 
Co-authored-by: Anton Lozhkov <aglozhkov@gmail.com>
@LysandreJik @sanchit-gandhi
Update .github/ISSUE_TEMPLATE/feature-request.yml
382ea4e 
Co-authored-by: Sanchit Gandhi <93869735+sanchit-gandhi@users.noreply.github.com>
@LysandreJik @patrickvonplaten
Update .github/ISSUE_TEMPLATE/bug-report.yml
51cb253 
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
@LysandreJik @patrickvonplaten
Update .github/ISSUE_TEMPLATE/bug-report.yml
d49c073 
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
@LysandreJik
Address review comments
f2d3344
@LysandreJik
Copy link
Member Author

The new layout looks good! I would like to have a section 'Code Snippet' if it is not in the new layout yet. slightly_smiling_face (Haven't really tried it yet, just looking the screenshots)

@ydshieh, yes the reproducible code example is available in the issue, I just migrated the existing issues so everything is still included.

Thanks for your reviews, merging!

@LysandreJik LysandreJik merged commit c11a495 into huggingface:main Apr 18, 2022
elusenji pushed a commit to elusenji/transformers that referenced this pull request Jun 12, 2022
@LysandreJik @anton-l
@sanchit-gandhi @patrickvonplaten @elusenji
Refactor issues with yaml (huggingface#16772)
9695022 
* Refactor issues with yaml

* Update .github/ISSUE_TEMPLATE/bug-report.yml

Co-authored-by: Anton Lozhkov <aglozhkov@gmail.com>

* Update .github/ISSUE_TEMPLATE/bug-report.yml

Co-authored-by: Anton Lozhkov <aglozhkov@gmail.com>

* Update .github/ISSUE_TEMPLATE/feature-request.yml

Co-authored-by: Sanchit Gandhi <93869735+sanchit-gandhi@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/bug-report.yml

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>

* Update .github/ISSUE_TEMPLATE/bug-report.yml

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>

* Address review comments

Co-authored-by: Anton Lozhkov <aglozhkov@gmail.com>
Co-authored-by: Sanchit Gandhi <93869735+sanchit-gandhi@users.noreply.github.com>
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anton-l anton-l anton-l left review comments

+4 more reviewers

@sgugger sgugger sgugger approved these changes

@sanchit-gandhi sanchit-gandhi sanchit-gandhi left review comments

@patrickvonplaten patrickvonplaten patrickvonplaten approved these changes

@patil-suraj patil-suraj patil-suraj approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@LysandreJik @HuggingFaceDocBuilderDev @ydshieh @patrickvonplaten @anton-l @patil-suraj @sgugger @sanchit-gandhi