Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Etiquette of GitHub Contributing, Pull Requests vs New Issue [closed]

I was wondering what the proper etiquette to contributing on GitHub is?

Should you submit a "New Issue" first and discuss the problem?

Or do you take some initiative, code, then do a "Pull Request" and discuss the code further there?

My concern with creating a "New Issue" first is that if you do a "Pull Request" after, there would be two issues #'s created... seems like a waste.

Thanks!

like image 238
Quang Van Avatar asked Mar 05 '12 08:03

Quang Van


People also ask

When should I close pull request GitHub?

You may choose to close a pull request without merging it into the upstream branch. This can be handy if the changes proposed in the branch are no longer needed, or if another solution has been proposed in another branch.

How often should you submit a pull request?

Particularly in less-established projects where you might have to continue building your work on the pull request you've just created, being blocked by a code review can be frustrating. To me, two times a day is a good interval for when to review.

What happens when a pull request is closed?

Close a pull request (console) After the status of a pull request is changed to Closed, it cannot be changed back to Open, but users can still comment on the changes and reply to comments.

Does closing a pull request cancel it?

If you sent a pull request on a repository where you don't have the rights to close it, you can delete the branch from where the pull request originated. That will cancel the pull request.


1 Answers

The difference is quite clear:

  • if you don't think you can contribute back a patch, open a new issue (following the same kind of checklist than the one described here).
  • if you think you can make some patch to fix the issue, fork the repo, and make a pull request (once you have pushed your patch back to your fork).

If you make a pull issue first, and then create a pull request, nothing stops you to reference the issue URL in your pull request comment, in order to avoid writing again the context of your patch.

like image 138
VonC Avatar answered Oct 16 '22 04:10

VonC