Skip to content

Improvements to Docs for new contributors #19344

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

Merged
merged 6 commits into from
Feb 5, 2021
Merged

Improvements to Docs for new contributors #19344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7941c36
add a header paragraph to the top level contributing tab
ianhi Jan 23, 2021
297070a
add install step to the Contributing code
ianhi Jan 23, 2021
bae3bad
move issues for new contributors higher up on the page
ianhi Jan 23, 2021
98971ac
update the versions to modern versions
ianhi Jan 23, 2021
ea230e3
Remove early link to gitwash and place description in the see also
ianhi Jan 23, 2021
7965576
Clarify description of good first issues
ianhi Feb 4, 2021
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
57 changes: 28 additions & 29 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ about the code, what makes for good documentation or a blog post, how to get inv
in community work, or get "pre-review" on your PR.


.. _new_contributors:

Issues for New Contributors
---------------------------

While any contributions are welcome, we have marked some issues as
particularly suited for new contributors by the label
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
These are well documented issues, that do not require a deep understanding of
the internals of Matplotlib. The issues may additionally be tagged with a
difficulty. ``Difficulty: Easy`` is suited for people with little Python experience.
``Difficulty: Medium`` and ``Difficulty: Hard`` are not trivial to solve and
require more thought and programming experience.

.. _submitting-a-bug-report:

Submitting a bug report
Expand Down Expand Up @@ -53,10 +67,10 @@ If you are reporting a bug, please do your best to include the following:

>>> import matplotlib
>>> matplotlib.__version__
'1.5.3'
'3.4.1'
>>> import platform
>>> platform.python_version()
'2.7.12'
'3.9.2'

We have preloaded the issue creation page with a Markdown template that you can
use to organize this information.
Expand Down Expand Up @@ -88,9 +102,6 @@ The preferred way to contribute to Matplotlib is to fork the `main
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
then submit a "pull request" (PR).

The best practices for using GitHub to make PRs to Matplotlib are
documented in the :ref:`development-workflow` section.

A brief overview is:

1. `Create an account <https://github.com/join>`_ on GitHub if you do not
Expand All @@ -102,34 +113,36 @@ A brief overview is:

3. Clone this copy to your local disk::

$ git clone https://github.com/YourLogin/matplotlib.git
git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git

4. Create a branch to hold your changes::
4. Enter the directory and install the local version of Matplotlib.
See ref`<installing_for_devs>` for instructions

$ git checkout -b my-feature origin/master
5. Create a branch to hold your changes::

git checkout -b my-feature origin/master

and start making changes. Never work in the ``master`` branch!

5. Work on this copy, on your computer, using Git to do the version control.
6. Work on this copy, on your computer, using Git to do the version control.
When you're done editing e.g., ``lib/matplotlib/collections.py``, do::

$ git add lib/matplotlib/collections.py
$ git commit
git add lib/matplotlib/collections.py
git commit

to record your changes in Git, then push them to GitHub with::

$ git push -u origin my-feature
git push -u origin my-feature

Finally, go to the web page of your fork of the Matplotlib repo, and click
'Pull request' to send your changes to the maintainers for review. You may
want to consider sending an email to the mailing list for more visibility.
'Pull request' to send your changes to the maintainers for review.

.. seealso::

* `Git documentation <https://git-scm.com/documentation>`_
* `Git-Contributing to a Project <https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
* `Introduction to GitHub <https://lab.github.com/githubtraining/introduction-to-github>`_
* :ref:`development-workflow`
* :ref:`development-workflow` for best practices for Matplotlib
* :ref:`using-git`

Contributing pull requests
Expand Down Expand Up @@ -216,20 +229,6 @@ tools:



.. _new_contributors:

Issues for New Contributors
---------------------------

New contributors should look for the following tags when looking for issues.
We strongly recommend that new contributors tackle issues labeled
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
as they are easy, well documented issues, that do not require an understanding of
the different submodules of Matplotlib.
This helps the contributor become familiar with the contribution
workflow, and for the core devs to become acquainted with the contributor;
besides which, we frequently underestimate how easy an issue is to solve!


.. _contributing_documentation:

Expand Down
15 changes: 15 additions & 0 deletions doc/devel/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@
The Matplotlib Developers' Guide
################################

Thank you for your interest in helping to improve Matplotlib! There are various
ways to contribute to Matplotlib. All of them are super valuable but don't necessarily
require writing code at all. For example:

- contributing to the documentation
- opening new issues for bugs
- requesting new features
- asking for clarification on things you find unclear
- fixing bugs

If you have any questions on the
process or how to fix something feel free to ask on `gitter
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
`discourse <discourse.matplotlib.org>`_ for longer questions.

.. raw:: html

<div style="margin: 2em 0;">
Expand Down