-
Notifications
You must be signed in to change notification settings - Fork 75
Improve issue templates #1470
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
Improve issue templates #1470
Conversation
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.
Nice work, the feedback here is targeted at allowing our teams to reproduce the issue with the minimal information needed, while keeping the barrier-for-reporting-issues as easy as possible. Hence why I proposed to slice some of the info that seems irrelevant,
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.
Perhaps mentioning:
- "Look at the closed issues before reporting the bug" (the issue might have already been solved previously) would be nice at the top of the bug_report
- Similarly "Look at the open issues before reporting" for feature_requests
Would it be good to include this?
What do you think about adding a one liner about fields/models: "Models/fields are automatically generated, if fields are missing, have a look at the openapi repository: https://github.com/Adyen/adyen-openapi to see whether the field is there?"
This line does not necessarily need to be part of the ISSUE_TEMPLATE
, but it could be left elsewhere f.e. CONTRIBUTING
or README
.
|
Description
This PR adds .yml bug report and feature request form that is structured to collect all essential details upfront.
Read more here.