Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ENH Improving the contribution guidelines #7236

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 13 commits into from
Nov 2, 2016
Merged

ENH Improving the contribution guidelines #7236

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d00c927
ENH contributing guidelines are now all in one place
NelleV Oct 8, 2016
419ce52
ENH Improved contributing documentation
NelleV Oct 8, 2016
0b9974c
DOC remove transformation.rst and hide license doc
NelleV Oct 8, 2016
085844a
FIX typo
NelleV Oct 8, 2016
9799d66
DOC improved organization and titles
NelleV Oct 8, 2016
9547bc7
ENH better styling for notes, warnings and see also section
NelleV Oct 11, 2016
5a9f988
DOC Better crosslinking of dev references
NelleV Oct 11, 2016
c97d6ac
DOC better title
NelleV Oct 11, 2016
54e0c9c
DOC no more addition to pyplot
NelleV Oct 12, 2016
76a5ab2
DOC fixes to the reviewer's guide
NelleV Oct 12, 2016
19603a5
DOC added easy-fix and new-contributor-friendly tags
NelleV Oct 12, 2016
388a4a0
DOC better styling for topic sections
NelleV Oct 12, 2016
4d8963f
DOC Transformations are now documented in the API
NelleV Oct 29, 2016
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
Prev Previous commit
Next Next commit
DOC added easy-fix and new-contributor-friendly tags
  • Loading branch information
@NelleV
NelleV committed Oct 29, 2016
commit 19603a54714b7dcd83509c62e53823873808e649
7 changes: 6 additions & 1 deletion doc/_static/mpl.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,11 +400,16 @@ div.admonition {
}


div.note {
div.note, div.topic {
background-color: #eee;
border: 1px solid #ccc;
}

p.topic-title {
font-size: 1.1em;
font-weight: bold;
}

div.seealso {
background-color: #FFFBE8;
border: 1px solid #fbeed5;
Expand Down
28 changes: 27 additions & 1 deletion doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ environment <http://conda.pydata.org/docs/using/envs.html>`_
* Edit setup.cfg to set `test` to True, and `local_freetype` to True
Copy link
Member

Choose a reason for hiding this comment

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

These should be double-backticks, right?

* If you have build matplotlib previously, remove the build folder.
Copy link
Member

Choose a reason for hiding this comment

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

build -> built, for the first one.

* Execute the build command.
<<<<<<< 8301de2110774994b720461335e5923998d80c99

When working on bleeding edge packages, setting up a
`virtual environment
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_ or a `conda
Expand Down Expand Up @@ -215,6 +215,32 @@ tools:
* :ref:`testing`
* :ref:`documenting-matplotlib`



.. _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 "new-contributor-friendly"
issues (easy, well documented issues, that do not require an understanding of
the different submodules of matplotlib) and "Easy-fix" issues. 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!

.. topic:: new-contributor-friendly

A great way to start contributing to matplotlib is to pick an item from
Copy link
Member

Choose a reason for hiding this comment

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

Can this note be consolidated with the block above? There is quite a bit of duplication here.

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah… I think it would be good to have topics if I had the courage to describe more of the labels that we use on the documentation, but that's not going to happen this week. So I'll just merge everything into one paragraph.

I had original planned a second topic on easy-fix, but I was rewriting the same thing as for new contributors.

the list of
`new-contributor-friendly <https://github.com/matplotlib/matplotlib/labels/new-contributor-friendly>`_
in the issue tracker. Resolving these issues allow you to start
contributing to the project without much prior knowledge. Your assistance
in this area will be greatly appreciated by the more experienced
developers as it helps free up their time to concentrate on other issues.


.. _other_ways_to_contribute:

Other ways to contribute
Copy link
Member

Choose a reason for hiding this comment

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

I suggest naming this section 'Contributing to documentation' and putting it first. The tex laments that documentation is under valued while putting it under a title that makes it sound under valued 😜

At risk of being overly micro-managing in comments, something to the effect of

We ❤️ documentation improvements and improving the documentation can be one of the highest-impact contributions. If you can use matplotlib you are qualified to contribute to the documentation. Did you find the docstring on a confusing? Fix it so the next person has an easier time. Could an [link to gallery]Example be improved? Open a PR!

I blame @rgbkrk for me urge to use emoji in 'serious' text.

Copy link

Choose a reason for hiding this comment

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

¯_(ツ)_/¯

Copy link

Choose a reason for hiding this comment

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

It can help in setting the tone for sections like this, I certainly get it.

Expand Down