r/github • • Nov 25 '23

This is why GitHub issues exist

Post image

Not to mention the low effort question with zero context, I find it extremely annoying lol 🤷‍♂️

768 Upvotes

72 comments sorted by

View all comments

3

u/bitingteeth Nov 26 '23

I’m just starting on GitHub…any tips so I can consciously avoid on being an asshat like this one?

12

u/u_int16 Nov 26 '23

Be very very very very very sure the problem is not your fault before you open an issue.

Make sure your issue contains enough information such that someone investigating it can cause the issue to happen, but not so much information that it is difficult to recreate your scenario. Fixing your issue will likely be harder than making the ticket for the issue, put effort into it.

In general remember nobody owes you anything. The nicer you ask and easier you make it for your issue to be fixed the more likely it will be fixed.

Take this person’s case:

They sent an email which is private and wont allow other people to look and try to fix things. Putting the onus directly on OP.

They didnt even copy paste the error (which could be searched) instead summarizing it.

They did not include any information on where the error was coming from. Not in location in code or in context of execution.

Honestly just use common sense. Youll be fine.

4

u/lupinegrey Nov 26 '23

Be very very very very very sure the problem is not your fault before you open an issue.

Be able to prove, reproduceably, that the problem is with their code.

7

u/BlackWarrior322 Nov 26 '23

The other comment has explained it wonderfully!

But just to add and highlight some important points.

Use GitHub issues, that way you’re not asking just a single person and anyone who uses the repository could possibly help you. Also it’s very nice to link issues to pull requests when a fix is eventually implemented.

And regarding asking the question the right way, I myself was quite bad when I started asking doubts on stackoverflow. Then I understood how to ask a “minimal reproducible example”. It boils down to this: You’d like someone to spend their time to help you out, show them why they should do so. Provide complete context and put effort into the question :)

4

u/xTakk Nov 26 '23

My small tip.. write it in a manner that is useful for fixing the product. You don't have issues, the code has issues. If you can't write a small code sample to expose the issue to be fixed, it's usually your issue and not an issue with the code.

The point overall is that GitHub is not about "free software". It's about sharing code. If you need product or code support, that probably belongs in a forum or in Discussions rather than Issues.

If you just show up for the code, you will be golden.

2

u/Balance- Nov 27 '23

Always include a minimal reproducible example https://stackoverflow.com/help/minimal-reproducible-example

If you don’t know if it’s a bug yet, open a Discussion instead of an Issue.