Opensource.guide: [suggestion] New guide: creating your first pull request

Created on 18 Feb 2017  路  8Comments  路  Source: github/opensource.guide

@hzoo wrote in #284

creating your first PR [...] should be a topic too

@sgrif did a great talk called "The Anatomy of a Pull Request". It doesn't look like the video ever got posted anywhere, but if it does it would make an excellent resource.

@cbeams wrote https://chris.beams.io/posts/git-commit/ which is my all-time-favorite article about how to write good git commits. It is also applicable to pull requests.

@keavy wrote https://github.com/blog/1943-how-to-write-the-perfect-pull-request

After a few frustrating interactions with some newer contributors I wrote http://tinyletter.com/exercism/letters/exercism-pull-requests

new-guide stale

All 8 comments

/cc @rafaelfranca You mentioned we might be able to get the video of when I gave it internally?

Awesome 馃槃! Would be cool to talk about:

  • some of the tips we all have (almost like RFCs)
  • as well as the workflow: initial PR (title, description, who to ping (if at all), maybe should make an issue before the PR, taking feedback and responding to comments, awareness that merging a pr may not be immediate or may not even be accepted unless an issue was created before and was approved, time to merge vs release, etc
  • maybe link examples of PRs that we think are good and why?
  • if it's your first PR (in general) vs first PR to a different project, don't stress out too much over it! You can always update it

l still looking for coworkers to my project. aerolab interacts poorly

One thing that came up at Maintainerati last week: project scope will determine whether or not a PR will be accepted (or should be accepted). One thing we might talk about is how to figure out before putting in a whole lot of work whether or not this change is something the project is open to / willing to consider.

figure out before putting in a whole lot of work whether or not this change is something the project is open to / willing to consider.

馃憤 . Kinda like what I was saying about not accepting a PR unless an issue was created before if it's a big change. We can also mention a more formal process such as doing RFCs (https://github.com/emberjs/rfcs).

I believe this still is worth keeping open. The next step on this is to write a bullet-point list of points/ideas/topics that should go into it, and then structure those in a rough outline for review.

Here's the link to @sgrif's video: https://www.youtube.com/watch?v=u2xzRUYrsWA

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

BaseMax picture BaseMax  路  3Comments

natdudley picture natdudley  路  3Comments

nayafia picture nayafia  路  7Comments

Victorsj picture Victorsj  路  6Comments

nayafia picture nayafia  路  8Comments