CODEWITHSUNDEEP
githubissue-tracking
Rhonda
Rhonda

Reputation: 1721

Adding issue to GitHub, what is etiquette

I'm new to GitHub, and am interested in someone's code. However, there is error, and I'd like to add issue, but I'm wondering if I should try to contact the person first (I don't know him, I saw his blog on something quite useful)

When I try googling GitHub etiquette, it refers to someone who owns the repository and has to address issues in a timely manner.

Thank you

Upvotes: 1

Views: 2246

Answers (1)

bitoiu
bitoiu

Reputation: 7464

Opening an issue as and tagging it as a question (for example) is much more useful and productive that sending an e-mail or contacting the repository maintainers directly.

Next time someone finds the same error or query, they will potentially also find a solution linked to the issue that you are going to created.

In terms of ettiquete GitHub has a great post on how to create pull-requests from which you might take some hints, but to be honest if you follow the guidelines from StackOverflow on how to ask a question they will in my opinion be good tips for whatever site you are targeting.

If it's a runtime or compilation (programming) error:

Include just enough code to allow others to reproduce the problem. For help with this, read How to create a Minimal, Complete, and Verifiable example.

If it's a question try to separate the goal that you are trying to achieve from the solution you've adopted that led to the error, at least that's what I try to do.

Upvotes: 4

Related Questions