python / python/devguide

Improvement to Lifecycle of a Pull Request at git push origin

Open
#780 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-git type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

Where:

When all of your changes are committed (i.e. git status doesn’t list anything), you will want to push your branch to your fork:

git push origin <branch name>

This will get your changes up to GitHub.

There is a step missing which gave me some issue. That is the bit about the git command responds with username and password. If you enter your GitHub password the response is:

Username for 'https://github.com':
Password for 'https://@github.com':
remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
fatal: Authentication failed for 'https://github.com//cpython.git/'

So I suggest adding enough info to get the beginners around this such that the page now reads:

Ensure that you have created a personal access token link.
Note that you will likely need the token until your changes have been accepted.
When all of your changes are committed (i.e. git status doesn’t list anything), you will want to push your branch to your fork:

git push origin <branch name>

At the password prompt:
Password for 'https://@github.com':

Enter you personal access token (ghp_1e3f...) instead of your usual GitHub password.
This will get your changes up to GitHub.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the developer-guide passage covering git push origin <branch name> and read its surrounding authentication instructions. Update it to explain GitHub personal access tokens at the password prompt, using the linked GitHub documentation; done means beginners are told not to enter their normal GitHub password.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.