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

Git_Basics.rst: Update interactive rebase section #6126

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rohanrk
Copy link
Member

@rohanrk rohanrk commented Oct 3, 2020

Expands squashing your commits section to explain different
interactive rebase commands

Closes #3930

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • [ x ] I read the commit guidelines and I've followed
    them.
  • [ x ] I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

Expands `squashing your commits` section to explain different
interactive rebase commands

Closes coala#3930
Copy link
Member

@abhishalya abhishalya left a comment

Choose a reason for hiding this comment

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

This is really good, much more helpful than before. Here are few comments but otherwise I think it's good to go :)

Squashing your commits
----------------------
Interactive Rebasing
---------------------
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
---------------------
--------------------

Rewording
---------

Equivalent to the `git commit --amend` except it applies to the specified commit. Use
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Equivalent to the `git commit --amend` except it applies to the specified commit. Use
Equivalent to the ``git commit --amend`` except it applies to the specified commit. Use

them down into a single commit with the interactive rebasing tool. To squash
your commits run the following command:

Keep the first one
Copy link
Member

Choose a reason for hiding this comment

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

This line is a bit too small, we can restructure this paragraph a bit to not waste any line space.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Newcomer's Guide.rst: Add documentation for deleting a commit from a branch
2 participants