Skip to content

Add README improvements. #16435

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 7 commits into from
May 23, 2017
Merged

Add README improvements. #16435

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bcd922c
Add README improvements.
May 22, 2017
6bc1512
Add README improvements.
May 22, 2017
da932b6
Add README improvements.
May 22, 2017
66f041b
Add README improvements.
May 22, 2017
62b6aae
Add README improvements.
May 22, 2017
80a42ec
edits
jorisvandenbossche May 23, 2017
29541b9
edits
jorisvandenbossche May 23, 2017
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
32 changes: 26 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ python setup.py build --compiler=mingw32
python setup.py install
```

See http://pandas.pydata.org/ for more information.
See **[the docs](http://pandas.pydata.org/pandas-docs/stable/install.html#installing-from-source)** for more information.

## License
BSD
Expand All @@ -220,9 +220,29 @@ Work on ``pandas`` started at AQR (a quantitative hedge fund) in 2008 and
has been under active development since then.

## Discussion and Development
Since pandas development is related to a number of other scientific
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).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think adding a StackOverflow link to [pandas] tag prob should be top item for general questions.

Copy link
Contributor

Choose a reason for hiding this comment

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

https://stackoverflow.com/questions/tagged/pandas

Copy link
Member

Choose a reason for hiding this comment

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

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"

Copy link
Author

Choose a reason for hiding this comment

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

That does sound like a good idea. I'll add it.

Copy link
Author

Choose a reason for hiding this comment

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

@jorisvandenbossche
Just saw your last comment after I submitted the latest change.
I'll move it to Getting Help.

Specialized discussions or design issues should take place on
the [pandas-dev mailing list](https://mail.python.org/mailman/listinfo/pandas-dev) / Google group:

https://groups.google.com/forum/#!forum/pydata
<<<<<<< HEAD
Copy link
Member

Choose a reason for hiding this comment

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

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)

Copy link
Author

Choose a reason for hiding this comment

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

Crap. I'll fix it....


## Contributing to pandas

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

A detailed overview on how to contribute can be found in the **[contributing guide.](http://pandas.pydata.org/pandas-docs/stable/contributing.html)**
=======
https://mail.python.org/mailman/listinfo/pandas-dev

## Contributing to pandas

**[How to contribute.](http://pandas.pydata.org/pandas-docs/stable/contributing.html)**
Copy link
Member

Choose a reason for hiding this comment

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

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"

Copy link
Author

Choose a reason for hiding this comment

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

Done.


All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.
>>>>>>> bcd922cd5200b61e590277f62804ebf307cc51c3

If you are simply looking to start working with the pandas codebase, navigate to the [GitHub “issues” tab](https://github.com/pandas-dev/pandas/issues) and start looking through interesting issues. There are a number of issues listed under [Docs](https://github.com/pandas-dev/pandas/issues?labels=Docs&sort=updated&state=open) and [Difficulty Novice](https://github.com/pandas-dev/pandas/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty+Novice%22) where you could start out.

Or maybe through using pandas you have an idea of your own or are looking for something in the documentation and thinking ‘this can be improved’...you can do something about it!

Feel free to ask questions on the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/pydata) or on [Gitter](https://gitter.im/pydata/pandas).