-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update issue templates #760
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
Conversation
bwaresiak
left a comment
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.
Thanks for the call @cmonfortep, my comments inline. 😄
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Smartphone (please complete the following information):** |
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.
I'd also ask people to include information about the version of the App they are using (and possibly the steps describing how they can check that) i.e.:
- DDG App Version: (e.g. 5.25.0)[1]
- Device: (e.g. Pixel 2, Samsung s10)
- OS: (e.g. Android 10)
- If applicable, add screenshots to help explain your problem.
[1] App version can be found in...
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
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.
Maybe at the end add something along the lines of:
If applicable, please include information about any settings that may be relevant to this issue (e.g. selected theme, auto clear option, etc).
| assignees: '' | ||
|
|
||
| --- | ||
|
|
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.
Shall we add a link to our contributing guidelines at the beginning?
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.
Not sure, I would say it's not necessary to read the contribution guidelines to file an issue. I see that more related to a real contribution.
|
@bwaresiak sorry for the delay here. I added the suggestions to the template. |
|
What's still required here to merge this? |
|
@CDRussell just @bwaresiak review. He will take a look today 👍 |
bwaresiak
left a comment
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.
Looks good to me! 👍
Task/Issue URL: https://app.asana.com/0/0/1164365196861356/f
Tech Design URL:
CC:
Description:
Introducing Issue templates. We are creating two different templates: Bugs and feature requests. They are based on the default ones except for some minor changes to reduce their content and adapt to our platform.
These templates are intended to guide users when reporting a bug or requesting a new feature/enhancement. They will bring more consistency between all the created issues. Reduce the time labeling issues in our repo. Finally, and most important, it will try to get all the information needed to understand each request from the moment of creation.
Steps to test this PR:
No need to test this PR. The PR has been automatically created by Github.
Internal references:
Software Engineering Expectations
Technical Design Template