/matplotlib

Added contribute information to readme #6778

Merged
merged 1 commit into from Jul 20, 2016

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
  2.1 (next point r...
3 participants
@story645 @tacaswell @QuLogic
@story645
Member

story645 commented Jul 17, 2016 • edited

Added a small contribute section to the bottom of the readme 'cause everyone has 'em and I would've found it useful. Language totally stolen from http://matplotlib.org/devel/gitwash/development_workflow.htm and just added a link to the dev workflow and making patch pages

story645 added the needs_review label Jul 17, 2016

@QuLogic QuLogic commented on an outdated diff Jul 17, 2016

View full outdated diff
README.rst
@@ -47,3 +47,15 @@ The first is a good starting point for general questions and discussions.
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/matplotlib/matplotlib
:target: https://gitter.im/matplotlib/matplotlib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+Contribute
+==========
+You've discovered a bug or something else you want to change - excellent!
+
+You've worked out a way to fix it – even better!
+
+You want to tell us about it – best of all!
+
+The easiest way to contribute is through github; if interested in doing so, browse the `development workflow <http://matplotlib.org/devel/gitwash/development_workflow.html>`_ guide.
@QuLogic

QuLogic Jul 17, 2016

Member

GitHub

@QuLogic QuLogic commented on an outdated diff Jul 17, 2016

View full outdated diff
README.rst
@@ -47,3 +47,15 @@ The first is a good starting point for general questions and discussions.
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/matplotlib/matplotlib
:target: https://gitter.im/matplotlib/matplotlib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+Contribute
+==========
+You've discovered a bug or something else you want to change - excellent!
+
+You've worked out a way to fix it – even better!
+
+You want to tell us about it – best of all!
+
+The easiest way to contribute is through github; if interested in doing so, browse the `development workflow <http://matplotlib.org/devel/gitwash/development_workflow.html>`_ guide.
+
+And if you don't want to use github, take a look at the guide to `making patches <http://matplotlib.org/devel/gitwash/patching.html>`_.
@QuLogic

QuLogic Jul 17, 2016

Member

GitHub; and we should probably fix the gitwash page, too.

@tacaswell tacaswell and 1 other commented on an outdated diff Jul 17, 2016

View full outdated diff
README.rst
@@ -47,3 +47,15 @@ The first is a good starting point for general questions and discussions.
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/matplotlib/matplotlib
:target: https://gitter.im/matplotlib/matplotlib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+Contribute
+==========
+You've discovered a bug or something else you want to change - excellent!
+
+You've worked out a way to fix it – even better!
+
+You want to tell us about it – best of all!
+
+The easiest way to contribute is through Github; if interested in doing so, browse the `development workflow <http://matplotlib.org/devel/gitwash/development_workflow.html>`_ guide.
+
+And if you don't want to use Github, take a look at the guide to `making patches <http://matplotlib.org/devel/gitwash/patching.html>`_.
@tacaswell

tacaswell Jul 17, 2016

Owner

I am not sure how this is not using github?

@story645

story645 Jul 17, 2016 • edited

Member

according to the making patches docs, it's 'cause you go through every github step except the rebase/push madness,

Then, send the generated patch files to the matplotlib mailing list — where we will thank you warmly.

Maybe rewrite to

And if you don't want to submit your changes via Github, take...

@QuLogic QuLogic and 1 other commented on an outdated diff Jul 17, 2016

View full outdated diff
README.rst
@@ -47,3 +47,15 @@ The first is a good starting point for general questions and discussions.
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/matplotlib/matplotlib
:target: https://gitter.im/matplotlib/matplotlib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+Contribute
+==========
+You've discovered a bug or something else you want to change - excellent!
+
+You've worked out a way to fix it – even better!
+
+You want to tell us about it – best of all!
+
+The easiest way to contribute is through Github; if interested in doing so, browse the `development workflow <http://matplotlib.org/devel/gitwash/development_workflow.html>`_ guide.
@QuLogic

QuLogic Jul 17, 2016

Member

GitHub, not Github.

@story645

story645 Jul 17, 2016 • edited

Member

😶
@story645 story645 Added contribute information to readme

Some checks were not successful

1 failing and 2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build failed
Details
continuous-integration/appveyor/pr — AppVeyor build succeeded
Details
coverage/coveralls — Coverage remained the same at 70.369%
Details
d291e80

@story645 story645 added Documentation needs_review and removed Documentation needs_review labels Jul 20, 2016

@story645
Member

story645 commented Jul 20, 2016

Ping...this is a a readme docfix so I'm gonna say the failure is travis being weird.

@tacaswell tacaswell merged commit 68e01df into matplotlib:master Jul 20, 2016
2 of 3 checks passed

2 of 3 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
coverage/coveralls Coverage remained the same at 70.369%
Details

tacaswell removed the needs_review label Jul 20, 2016

QuLogic added this to the 2.1 (next point release) milestone Jul 20, 2016

story645 deleted the story645:readmecontribute branch Aug 3, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment