From 91e24d3fecbb9cb85851ee0ca7bfb09d7fab77f4 Mon Sep 17 00:00:00 2001 From: Scott Harp Date: Mon, 12 Jun 2023 12:46:04 -0700 Subject: [PATCH 1/2] Added links to GitHub tutorials/resources for forking workflows in contributing.rst --- doc/source/development/contributing.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index ea69f0b907d8b..b1fcb5b47f2ae 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -119,6 +119,21 @@ Some great resources for learning Git: * the `NumPy documentation `_. * Matthew Brett's `Pydagogue `_. +Also, the project follows a forking workflow further described on this page whereby contributors +fork the repository, make changes and then create a pull request. So please be sure to read and +follow all the instructions in this guide. + +If you are new to contributing to projects through forking on GitHub, +take a look at the `GitHub documentation for contributing to projects `_. +GitHub provides a quick tutorial using a test repository that may help you become more familiar +with forking a repository, cloning a fork, creating a feature branch, pushing changes and making pull requests. + +Below are some useful resources for learning more about forking and pull requests on GitHub: + +* the `GitHub documentation for forking a repo `_. +* the `GitHub documentation for creating a pull request from a fork `_. +* the `GitHub documentation for working with forks `_. + Getting started with Git ------------------------ From 5a679c6def9c80458b1159398b060a0c1c71bca9 Mon Sep 17 00:00:00 2001 From: Scott Harp Date: Mon, 12 Jun 2023 22:48:32 -0700 Subject: [PATCH 2/2] updated with shortened link and minor reformatting --- doc/source/development/contributing.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index b1fcb5b47f2ae..4b9a6ba1e069c 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -119,19 +119,20 @@ Some great resources for learning Git: * the `NumPy documentation `_. * Matthew Brett's `Pydagogue `_. -Also, the project follows a forking workflow further described on this page whereby contributors -fork the repository, make changes and then create a pull request. So please be sure to read and -follow all the instructions in this guide. +Also, the project follows a forking workflow further described on this page whereby +contributors fork the repository, make changes and then create a pull request. +So please be sure to read and follow all the instructions in this guide. If you are new to contributing to projects through forking on GitHub, take a look at the `GitHub documentation for contributing to projects `_. GitHub provides a quick tutorial using a test repository that may help you become more familiar -with forking a repository, cloning a fork, creating a feature branch, pushing changes and making pull requests. +with forking a repository, cloning a fork, creating a feature branch, pushing changes and +making pull requests. Below are some useful resources for learning more about forking and pull requests on GitHub: * the `GitHub documentation for forking a repo `_. -* the `GitHub documentation for creating a pull request from a fork `_. +* the `GitHub documentation for collaborating with pull requests `_. * the `GitHub documentation for working with forks `_. Getting started with Git