Opened 6 years ago

Closed 6 years ago

#29766 closed Cleanup/optimization (worksforme)

Add admonition after submit a new commit

Reported by: Windson yang Owned by: nobody
Component: Documentation Version: 2.1
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

I used to use git rebase -i to amend the local commits and git push -f once the maintainer asks me to update a patch. But that makes the maintainers hard to review my code. Instead, I should just create a new commit. Then let the maintainers to squash when they merge the diff. I'm not sure this is my own problem or we should mention the workflow at https://docs.djangoproject.com/en/2.1/intro/contributing/#pushing-the-commit-and-making-a-pull-request

Change History (2)

comment:1 by Carlton Gibson, 6 years ago

Hi Windson.

... hard to review my code. Instead, I should just create a new commit...

Sometimes, yes. Often, no. The commit history isn't that helpful for most patches. For some it is (especially if well crafted).

Whether to push a single commit or steps is a question of judgement. I'm not sure what we'd add to the docs about that.
I guess I'm inclined to think the advice towards a single commit if the best baseline. (Allowing individuals to judge otherwise.)

Do you have a specific change in mind?

comment:2 by Tim Graham, 6 years ago

Resolution: worksforme
Status: newclosed

The suggested workflow is described in more detail at Working with Git and GitHub. As Carlton said, if you have a specific change in mind, feel free to send a pull request.

Note: See TracTickets for help on using tickets.
Back to Top