search

2DegreesInvesting / ds-incubator

2° Investing Initiative, ds-incubator website / eBook:
https://bit.ly/ds-incubator-videos
1 stars 4 forks source link

Pull request helpers #3

Open maurolepore opened 5 years ago

maurolepore commented 5 years ago

I will present the main Helpers for GitHub pull requests of the usethis package. If you want to warm up, read this article.

Video recording

maurolepore commented 5 years ago

During this meetup, @cjyetman asked to compare two workflows:

  1. A contributor adds commits to a branch off their fork of the source repository, then submits a pull request to the source repo.

  2. A contributor adds commits to a branch off the source repository directly.

I have thought a bit about this and I now have something more to share. I favour approach (1) because:

a. Pull requests provide infrastructure to have and permanently record a discussion about the proposed changes.

b. Asking the contributors to branch off their forks leaves the source repository clean from temporary branches, ideally, the source repo would have just a master branch and all feature branches` live in the contributor's forks -- except maybe for temporary branches that the maintainers are working on.

c. The contributors need no privilege other than "read" the source repository, which makes it clearer the special responsibility of the maintainers.

maurolepore commented 5 years ago

During this meetup @Clare2D asked how to deal with more complex and realistic scenarios. A demonstration of that was outside the scope of this particular meetup, but I plan two more meetups to cover more complex yet common scenarios (#9 and #10).