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.

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

Update user documentation of Sportsipy #783

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update user documentation of Sportsipy #783

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8a0f966
Update README with contributor guide
dannyothello May 9, 2023
aaffa8a
Add punctuation to doc
dannyothello May 9, 2023
a5ea0e0
Add project status update
dannyothello Jun 15, 2023
e60fd1b
Add space between status updates
dannyothello Jun 15, 2023
0194814
Add punctuation
dannyothello Jun 15, 2023
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
26 changes: 26 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ Sportsipy: A free sports API written for python
opening a pull request for any new features or bug fixes to be reviewed and
merged.**

**IMPORTANT UPDATE(6/14/2023): As a result of this project having fallen out of active
maintenance for years, the current version of Sportsipy no longer works as intended.
Recent users have reported that python files will run but no data returns despite
correctly installing Sportsipy and importing the modules. New users are recommended to visit
https://github.com/davidjkrause/sportsipy/tree/pyquery2 for a working, updated version of Sportsipy
until the original project maintainers agree to incorporate the fixes into this repository.**

.. image:: https://github.com/roclark/sportsipy/workflows/Sportsipy%20push%20tests/badge.svg
:target: https://github.com/roclark/sportsipy/actions
.. image:: https://readthedocs.org/projects/sportsipy/badge/?version=latest
Expand Down Expand Up @@ -160,6 +167,25 @@ the documentation for a full list of all metrics and information exposed by
sportsipy. The documentation is auto-generated using Sphinx based on the
docstrings in the sportsipy package.

How to get started contributing
===============================

Hello! Sportsipy is an open source project that welcomes contributors of all backgrounds and levels of experience.

If you wish to contribute, please consider forking this repo and opening a pull request.
A great guide on the process of contributing to an open source project on Github can be found
`here <https://www.dataschool.io/how-to-contribute-on-github/>`_.

You can also open a new Issue and discuss potential contributions with other developers before working on them.
More information on Github Issues can be found
`here <https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues>`_.
If you already have a clear idea for an existing Issue, simply opening a pull request is also fine.

Please refer to the `CONTRIBUTING.md file <https://github.com/dannyothello/sportsipy/blob/master/CONTRIBUTING.md>`_
for more detailed information for examples of welcome contributions and general good practices for code contributions.

For a more direct communication channel to project maintainers, please feel free to contact the team at [email protected]

Testing
=======

Expand Down