Skip to content
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

DOC: Add questions/contributing section to README #1889

Merged
merged 3 commits into from Jul 18, 2017
Merged

Conversation

@freddiev4
Copy link
Contributor

@freddiev4 freddiev4 commented Jul 16, 2017

No description provided.

@coveralls
Copy link

@coveralls coveralls commented Jul 16, 2017

Coverage Status

Coverage remained the same at 87.492% when pulling 8306dc6 on add-readme-sections into 07a0f6a on master.

@freddiev4 freddiev4 requested a review from richafrank Jul 17, 2017
Copy link
Member

@richafrank richafrank left a comment

Nice additions @freddiev4 ! I just had some small fixes.

README.rst Outdated
Questions?
==========

If you find a bug feel free to `open an issue <https://github.com/quantopian/zipline/issues/new>`_ and fill out the issue template.

This comment has been minimized.

@richafrank

richafrank Jul 17, 2017
Member

How about a comma after "bug"?

README.rst Outdated
Contributing
============

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. Details on how to set up a development environment can be found in our `development guidelines <http://zipline.io/development-guidelines.html>`_

This comment has been minimized.

@richafrank

richafrank Jul 17, 2017
Member

Missing a period at the end. Also, I'm a stickler for the oxford comma after "enhancements", if you please.

README.rst Outdated

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. Details on how to set up a development environment can be found in our `development guidelines <http://zipline.io/development-guidelines.html>`_

If you are simply looking to start working with the Zipline codebase, navigate to the GitHub `issues` tab and start looking through interesting issues. Sometimes there are of issues labeled as `Beginner Friendly <https://github.com/quantopian/zipline/issues?q=is%3Aissue+is%3Aopen+label%3A%22Beginner+Friendly%22>`_ or `Help Wanted <https://github.com/quantopian/zipline/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22>`_

This comment has been minimized.

@richafrank

richafrank Jul 17, 2017
Member

Let's lose "simply". Extra word "of" in "Sometimes there are of issues".

@coveralls
Copy link

@coveralls coveralls commented Jul 17, 2017

Coverage Status

Coverage remained the same at 87.492% when pulling c9c3cfa on add-readme-sections into 07a0f6a on master.

@freddiev4
Copy link
Contributor Author

@freddiev4 freddiev4 commented Jul 18, 2017

@richafrank good for another pass :)

Copy link
Member

@richafrank richafrank left a comment

Found one thing. Otherwise, looks great!

README.rst Outdated

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. Details on how to set up a development environment can be found in our `development guidelines <http://zipline.io/development-guidelines.html>`_.

If you are looking to start working with the Zipline codebase, navigate to the GitHub `issues` tab and start looking through interesting issues. Sometimes there are issues labeled as `Beginner Friendly <https://github.com/quantopian/zipline/issues?q=is%3Aissue+is%3Aopen+label%3A%22Beginner+Friendly%22>`_ or `Help Wanted <https://github.com/quantopian/zipline/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22>`_

This comment has been minimized.

@richafrank

richafrank Jul 18, 2017
Member

Period missing after the links.

@coveralls
Copy link

@coveralls coveralls commented Jul 18, 2017

Coverage Status

Coverage remained the same at 87.492% when pulling 1ab996c on add-readme-sections into 07a0f6a on master.

@freddiev4 freddiev4 merged commit 15fe38c into master Jul 18, 2017
2 checks passed
2 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@freddiev4 freddiev4 deleted the add-readme-sections branch Jul 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.