Skip to content

Instantly share code, notes, and snippets.

@firyalff
Created November 7, 2019 04:39
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save firyalff/ca4cd1203931eff1641d58f4d0eead1d to your computer and use it in GitHub Desktop.
Save firyalff/ca4cd1203931eff1641d58f4d0eead1d to your computer and use it in GitHub Desktop.
Sample Issue

Issue General Information

This is a sample issue to be used as a template for every bugs or even suggestion for improvement. Issue raised in each repository better be following this sample issue structure. The first section is general info of the issue while this paragraph also works as an general info example. Every problem occurred in development cycle MUST be written as repository issue to ease problem follow-ups.

Step to Reproduce

  1. In this section you need to describe the steps to reproduce the issue
  2. The steps written needs to be as detailed and complete as possible
  3. Since this will help devs to trace and find the solution

Expected Result

{
    the: "Expected Result",
    which: "is the related feature goal",
    should: "be written here",
    of: "course, it need to be as detailed as possible",
    you: "can also put image in here"
}

Actual Result

{
    the: "Actual Result",
    is: "the result you get",
    which: "is the reason",
    you: "took it as an issue",
    same: "as actual result, you can also put image in here"
}

Additional Information

In this section, you can put every single additional information that can help devs solving the problem, whether it is a technical suggestion or any other workaround you have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment