Skip to content

Why we should use github issues.  #92

@skyler1ackerman

Description

@skyler1ackerman

The nice thing about github issues is that you can describe the exact bug or feature that needs to be added. For example, say my bot had a typo, I could include a screenshot of what is going wrong like so;

screen4 2

We can also mention other issues if they overlap by mentioning the issue number, like #2.

We can say the exact steps to get to the specific bug like so

  • Go to the first step
  • Select the second button
  • Click the third button from the right
    -> This line says what the expected behavior is, followed by what it's doing now. For example, the bot is supposed to send a message saying "Have a nice day", but it currently says "Have a dice nay".

We can link pages, @people (@skyler1ackerman), assign users, label issues as bug, enhancement, priority, etc.

We can link later pull requests to the issue number to close them automatically and have to type up less in the PR itself. For example, instead of having to reexplain what the bug is, you can just say fixes #34 in the PR.

And, finally and most importantly, any discussion about a bug is documented in a set issue. The only other way to keep it this organized would be like if we made a new discord channel for every bug, which would be a mess.

Oh and also this is how you would do it in the industry.

Metadata

Metadata

Labels

designdocumentationImprovements or additions to documentationhelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions