Skip to content

DOC: Link to dev version of contributing guide from README.md #24172

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.

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 3 commits into from
Dec 17, 2018

Conversation

jamesmyatt
Copy link
Contributor

README.md should link to the development version of the contributing guide, since the stable version may not match current practice for master. For example, see #24069 .

I'm not sure this PR is a good idea, but I thought it was easiest open it and get comments directly.

@codecov
Copy link

codecov bot commented Dec 9, 2018

Codecov Report

Merging #24172 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24172      +/-   ##
==========================================
+ Coverage   92.21%   92.21%   +<.01%     
==========================================
  Files         162      162              
  Lines       51723    51723              
==========================================
+ Hits        47694    47695       +1     
+ Misses       4029     4028       -1
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 43.03% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 87.41% <0%> (-0.1%) ⬇️
pandas/io/json/json.py 93.09% <0%> (+0.47%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 949b148...b5460c3. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 9, 2018

Codecov Report

Merging #24172 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24172   +/-   ##
=======================================
  Coverage   92.21%   92.21%           
=======================================
  Files         162      162           
  Lines       51723    51723           
=======================================
  Hits        47694    47694           
  Misses       4029     4029
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 43.03% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/datetimes.py 98.56% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 949b148...0109662. Read the comment docs.

@jreback
Copy link
Contributor

jreback commented Dec 9, 2018

this would be fine. @jorisvandenbossche @TomAugspurger

@jreback jreback added the Docs label Dec 9, 2018
@TomAugspurger
Copy link
Contributor

Yeah, that's probably best. That link does occasionally break if a build fails, but not too often.

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

lgtm

@jamesmyatt
Copy link
Contributor Author

jamesmyatt commented Dec 10, 2018

There are 3 other places in the repo that could be changed too:

My inclination is to change the first, but leave the others alone so that internal references in docs are maintained. What do you think?

@jamesmyatt
Copy link
Contributor Author

I'm also concerned about duplication between .github/CONTRIBUTING.md (which I've only just found) and the contributing section of README.md.

@jorisvandenbossche
Copy link
Member

My inclination is to change the first,

I think you can change the first two (and the third could actually use sphinx syntax to make a link, so it always links to the same version)

@datapythonista datapythonista self-assigned this Dec 11, 2018
@datapythonista
Copy link
Member

@jorisvandenbossche are you ok with this now?

@TomAugspurger
Copy link
Contributor

I think changing the link in overview.rst to be a Sphinx ref makes sense.

@jreback jreback added this to the 0.24.0 milestone Dec 17, 2018
@jreback jreback merged commit 66fb798 into pandas-dev:master Dec 17, 2018
@jreback
Copy link
Contributor

jreback commented Dec 17, 2018

thanks @jamesmyatt

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Dec 17, 2018 via email

@jamesmyatt
Copy link
Contributor Author

@TomAugspurger , sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants