Add README improvements. #16435
Add README improvements. #16435
Conversation
README.md
Outdated
| @@ -225,4 +225,16 @@ Python projects, questions are welcome on the scipy-user mailing | |||
| list. Specialized discussions or design issues should take place on | |||
There was a problem hiding this comment.
can you remove the mention of scipy-user on the line above?
I would make the logic like "general questions are welcome on the pydata mailing list, specialized discussion related to pandas development on pandas-dev"
README.md
Outdated
|
|
||
| ## Contributing to pandas | ||
|
|
||
| **[How to contribute.](http://pandas.pydata.org/pandas-docs/stable/contributing.html)** |
There was a problem hiding this comment.
Small comment: I would put this after the "all contributions ... welcome" line, and make it a full sentence. Something like "The best starting point is the contributing guide". or "A detailed overview on how to contribute can be found in the contributing guide"
README.md
Outdated
|
|
||
| https://groups.google.com/forum/#!forum/pydata | ||
| <<<<<<< HEAD |
There was a problem hiding this comment.
You seem to have some eft-overs from a rebase / merge conflict (although not sure where this is coming from)
(apart from that the updates look god)
Codecov Report
@@ Coverage Diff @@
## master #16435 +/- ##
==========================================
- Coverage 90.42% 90.4% -0.03%
==========================================
Files 161 161
Lines 51023 51023
==========================================
- Hits 46138 46125 -13
- Misses 4885 4898 +13
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #16435 +/- ##
==========================================
- Coverage 90.42% 90.42% -0.01%
==========================================
Files 161 161
Lines 51023 51023
==========================================
- Hits 46138 46137 -1
- Misses 4885 4886 +1
Continue to review full report at Codecov.
|
|
Are you going to be able to squash them on your end? I'm not sure how to do it once it's already pushed to github. |
|
@steven-cutting yeah, we squash and merge. All good @jorisvandenbossche ? |
README.md
Outdated
| Python projects, questions are welcome on the scipy-user mailing | ||
| list. Specialized discussions or design issues should take place on | ||
| the PyData mailing list / Google group: | ||
| General questions and discussions can take place on the [pydata mailing list](https://groups.google.com/forum/?fromgroups#!forum/pydata). |
There was a problem hiding this comment.
I think adding a StackOverflow link to [pandas] tag prob should be top item for general questions.
There was a problem hiding this comment.
There was a problem hiding this comment.
That's true, we should mention stakcverflow somewhere as well (though the section is originally about "development" dicussion, so then mailing list is more appropriate as stack overflow
StackOverflow would maybe more suit under a title "Getting help"
There was a problem hiding this comment.
That does sound like a good idea. I'll add it.
There was a problem hiding this comment.
@jorisvandenbossche
Just saw your last comment after I submitted the latest change.
I'll move it to Getting Help.
|
@jreback @jorisvandenbossche |
|
@steven-cutting I made a small edit and split it just in two separate sections ("Gettting Help" and "Discussion and development") Thanks for the PR! |
|
@jorisvandenbossche |
** Included reference to contribute guide in READEME.
** In the "installation from source" section, refer to the actual section in the docs, instead of to the general website
** Update "Discussion and Development" section: remove reference to scipy mailing list, but add one to pandas-dev mailing list