Skip to content

Commit 038b628

Browse files
ssharp0im-vinicius
authored and
im-vinicius
committed
DOC: Added links to GitHub tutorials/resources for Forking Workflow in contributing.rst (pandas-dev#53628)
* Added links to GitHub tutorials/resources for forking workflows in contributing.rst * updated with shortened link and minor reformatting
1 parent 50f4af3 commit 038b628

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/source/development/contributing.rst

+16
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,22 @@ Some great resources for learning Git:
119119
* the `NumPy documentation <https://numpy.org/doc/stable/dev/index.html>`_.
120120
* Matthew Brett's `Pydagogue <https://matthew-brett.github.io/pydagogue/>`_.
121121

122+
Also, the project follows a forking workflow further described on this page whereby
123+
contributors fork the repository, make changes and then create a pull request.
124+
So please be sure to read and follow all the instructions in this guide.
125+
126+
If you are new to contributing to projects through forking on GitHub,
127+
take a look at the `GitHub documentation for contributing to projects <https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_.
128+
GitHub provides a quick tutorial using a test repository that may help you become more familiar
129+
with forking a repository, cloning a fork, creating a feature branch, pushing changes and
130+
making pull requests.
131+
132+
Below are some useful resources for learning more about forking and pull requests on GitHub:
133+
134+
* the `GitHub documentation for forking a repo <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_.
135+
* the `GitHub documentation for collaborating with pull requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests>`_.
136+
* the `GitHub documentation for working with forks <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks>`_.
137+
122138
Getting started with Git
123139
------------------------
124140

0 commit comments

Comments
 (0)