quozl
commented
5 years ago Thanks for the issue.
However, I don't think this is a problem worth fixing. A template wastes a lot of time, both of the people who prepare it, and the people who try to answer it. If you can't communicate a problem using international English, a template isn't going to help you much. It will harm instead; it will deceive you into only answering the template headings, and not thinking through what information to provide.
Of the templates I've seen in use, the simplest seem best; what did you do, what did you expect, what did you see?
The template you've proposed in https://github.com/sugarlabs/sugar-docs/pull/182 and used here doesn't make sense to me. What replicates the title, and can be omitted. Why would typically be too obvious. Links would be only rarely used. That leaves everything to Notes.
Aniket21mathur
What No Template for writing an issue in contributing.md file.
Why As a new user, I can't find any template on how to write/report an issue, in order to follow best practices for documenting an issue.
Link(s) to documentation/specs https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md?fbclid=IwAR09iMb540v7ZY41-LYLR7BkVuCyZsslAW6__1QJ1H-gOI2NahywNsb1gHw#workflow
Notes The benefit of having a template of writing an issue is that it ensures everyone involved will have a shared understanding of the tasks/requirements. It will give a sense of structure on how to report an issue, avoid any ambiguity, and make it easier for others to recreate the issue to provide better assistance/feedback.