Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify fork-based contributions #4619

Merged
merged 2 commits into from
Mar 21, 2019
Merged

Specify fork-based contributions #4619

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f631fe
Specify fork based contributions [skip ci]
jrbourbeau Mar 21, 2019
99013e5
Update introductory label to good first issue [skip ci]
jrbourbeau Mar 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/source/develop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ The community discusses and tracks known bugs and potential features in the
you should raise it there to start public discussion.

If you are looking for an introductory issue to get started with development,
then check out the `introductory label`_, which contains issues that are good
then check out the `"good first issue" label`_, which contains issues that are good
for starting developers. Generally, familiarity with Python, NumPy, Pandas, and
some parallel computing are assumed.

.. _`introductory label`: https://github.com/dask/dask/issues?q=is%3Aissue+is%3Aopen+label%3Aintroductory
.. _`"good first issue" label`: https://github.com/dask/dask/labels/good%20first%20issue


Development Environment
Expand All @@ -68,9 +68,12 @@ Development Environment
Download code
~~~~~~~~~~~~~

Clone the main Dask git repository (or whatever repository you're working on)::
Make a fork of the main `Dask repository <https://github.com/dask/dask>`_ and
clone the fork::

git clone git@github.com:dask/dask.git
git clone https://github.com/<your-github-username>/dask
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would actually recommend to clone the main repo and add your fork as an additional remote. Otherwise you won't get updates from master in your clone.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review @xhochy, that's a good point. However since we don't go into much detail about git workflows here, and instead link to the pandas contributing guide which recommends cloning the fork and adding the main repo as an upstream remote, I have a slight preference for staying with cloning the fork. I think this consistency could help contributors who are new to git or GitHub.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I personally add the main branch as upstream, and keep origin as my fork. Updating from master is then just git pull upstream master.


Contributions to Dask can then be made by submitting pull requests on GitHub.


Install
Expand Down