NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Commit7f50e7a

authored

Merge pull request#25845 from story645/remote

more explict about what remote means in context

2 parents98f36e3 +eaac6a7 commit7f50e7aCopy full SHA for 7f50e7a

File tree

2 files changed

+23

-18

lines changed

doc/devel
- development_setup.rst
- development_workflow.rst

2 files changed

+23

-18

lines changed

`‎doc/devel/development_setup.rst`

Lines changed: 22 additions & 17 deletions

Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,8 @@ Retrieve the latest version of the code`
`35`	`35`	`=======================================`
`36`	`36`
`37`	`37`	`Now that your fork of the repository lives under your GitHub username, you can`
`38`		`-retrieve thelatest sourceswith one of the following commands (where your`
`39`		-shouldreplace ``<your-username>`` with your GitHub username):
	`38`	`+retrieve themost recent version of the source codewith one of the following`
	`39`	+commands (replace ``<your-username>`` with your GitHub username):
`40`	`40`
`41`	`41`	`..tab-set::`
`42`	`42`
@@ -59,14 +59,12 @@ should replace ``<your-username>`` with your GitHub username):
`59`	`59`
`60`	`60`
`61`	`61`	This will place the sources in a directory:file:`matplotlib` below your
`62`		-current working directory and setupthe ``origin``remoteto point to your own
`63`		`-fork.Change into this directory before continuing::`
	`62`	+current working directory and set theremote name``origin`` to point to your
	`63`	`+fork. Change into this directory before continuing::`
`64`	`64`
`65`	`65`	`cd matplotlib`
`66`	`66`
`67`		-Now set up the ``upstream`` remote to point to the Matplotlib main repository,
`68`		-so that you can access the latest changes there (see also `Managing remote repositories
`69`		-<https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`__.):
	`67`	+Now set the remote name ``upstream`` to point to the Matplotlib main repository:
`70`	`68`
`71`	`69`	`..tab-set::`
`72`	`70`
@@ -82,18 +80,25 @@ so that you can access the latest changes there (see also `Managing remote repos
`82`	`80`
`83`	`81`	`git remote add upstream git@github.com:matplotlib/matplotlib.git`
`84`	`82`
`85`		`-..note::`
	`83`	+You can now use ``upstream`` to retrieve the most current snapshot of the source
	`84`	+code, as described in:ref:`development-workflow`.
`86`	`85`
`87`		- For more information on ``git`` and ``GitHub``, check the following resources.
	`86`	+..dropdown::Additional ``git`` and ``GitHub`` resources
	`87`	`+:color: info`
	`88`	`+:open:`
	`89`	`+`
	`90`	+ For more information on ``git`` and ``GitHub``, see:
	`91`	`+`
	`92`	+ * `Git documentation<https://git-scm.com/doc>`_
	`93`	+ * `GitHub-Contributing to a Project<https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
	`94`	+ * `GitHub Skills<https://skills.github.com/>`_
	`95`	+ *:ref:`using-git`
	`96`	+ *:ref:`git-resources`
	`97`	+ * `Installing git<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
	`98`	+ * `Managing remote repositories<https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`_
	`99`	`+ * https://tacaswell.github.io/think-like-git.html`
	`100`	`+ * https://tom.preston-werner.com/2009/05/19/the-git-parable.html`
`88`	`101`
`89`		- * `Git documentation<https://git-scm.com/doc>`_
`90`		- * `GitHub-Contributing to a Project<https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
`91`		- * `GitHub Skills<https://skills.github.com/>`_
`92`		- *:ref:`using-git`
`93`		- *:ref:`git-resources`
`94`		- * `Installing git<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
`95`		`- * https://tacaswell.github.io/think-like-git.html`
`96`		`- * https://tom.preston-werner.com/2009/05/19/the-git-parable.html`
`97`	`102`
`98`	`103`	`.. _dev-environment:`
`99`	`104`

`‎doc/devel/development_workflow.rst`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ To keep your work well organized, with readable history, and in turn make it`
`13`	`13`	`easier for project maintainers (that might be you) to see what you've done, and`
`14`	`14`	`why you did it, we recommend the following:`
`15`	`15`
`16`		-* Don'tuseyour ``main`` branch for anything. Consider deleting it.
	`16`	+* Don'tmake changes inyourlocal``main`` branch! Consider deleting it.
`17`	`17`	`* Before starting a new set of changes, fetch all changes from`
`18`	`18`	``upstream/main``, and start a new feature branch from that.
`19`	`19`	`* Make a new branch for each feature or bug fix — "one task, one branch".`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit7f50e7a

File tree

2 files changed

2 files changed

`‎doc/devel/development_setup.rst`

`‎doc/devel/development_workflow.rst`

0 commit comments