Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update CONTRIBUTING.md on how to fix git commits to have a clean history #1164

Merged
merged 2 commits into from
Jul 22, 2020

Conversation

WeiqunZhang
Copy link
Member

No description provided.

@WeiqunZhang WeiqunZhang requested review from atmyers and asalmgren July 22, 2020 01:01
Comment on lines +197 to +198
git branch -D development
git checkout -b development upstream/development
Copy link
Member

Choose a reason for hiding this comment

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

The parts around look good, but why do we pro-actively recommend to remove and re-check out the local development branch? :)

Copy link
Member Author

Choose a reason for hiding this comment

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

In my observation of PRs with dozens of already merged commits but only one real commit, the root cause is almost always development branch being diverged. Yes, it's not necessary in some situations, but people who are in those usually do not need the instructions here.

Copy link
Member

Choose a reason for hiding this comment

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

I see. Just wondering because if you show them how to rebase against the remote development branch it does not matter what the status of the local development branch is.

One could potentially split the 2nd part with that rationale in a smaller chunk after that, just to make it appear less magic to the reader.

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
@WeiqunZhang WeiqunZhang merged commit 39d03b8 into AMReX-Codes:development Jul 22, 2020
@WeiqunZhang WeiqunZhang deleted the git_rebase branch July 22, 2020 17:49
dwillcox pushed a commit to dwillcox/amrex that referenced this pull request Oct 3, 2020
…ory (AMReX-Codes#1164)

* update CONTRIBUTING.md on how to fix git commits to have a clean history

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants