Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

State that we prefer rebasing over merging PRs #548

Merged
merged 1 commit into from
Dec 14, 2015
Merged

State that we prefer rebasing over merging PRs #548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Also, make sure that your PRs do not contain unnecessary commits. If you think
some of your commits should be merged into a single one, feel free to [squash
them](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History).

Please [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) outdated
PRs on master to help with the reviews (rebasing is preferred over merging to
keep a clean history in a branch/PR).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't think adding a quick command line would help? git rebase master or something like this?
Oh wait, folks also need to update their fork wrt the upstream repo... So maybe a GitHub link on top of the Git link would help.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, folks also need to update their fork wrt the upstream repo...

Yes, my brain took the same path as yours ;-)

So maybe a GitHub link on top of the Git link would help.

Why not, but which one ? I haven't found any good page for that.

(on a more general note, I expect contributors to be a bit capable with git or willing to learn simple things by themselves, that's why I don't want to provide copy-paste-dumbly commands on CONTRIBUTING.md). A link would be good though.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.


Additionally, give extra care to your commit messages, as they will help us
review your PRs as well as help other contributors in the future, when exploring
the history. The general rules are to [use the imperative present
Expand Down