From 8a0f9668f03f5091a016085f64552192a9531580 Mon Sep 17 00:00:00 2001 From: Daniel Hong Date: Mon, 8 May 2023 22:18:23 -0400 Subject: [PATCH 1/5] Update README with contributor guide --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.rst b/README.rst index 7c4e6d11..77a4530c 100644 --- a/README.rst +++ b/README.rst @@ -160,6 +160,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 `_ + +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 `_ +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 `_ +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 robdclark@outlook.com + Testing ======= From aaffa8a2e5b2eff25e8786fac06c37851c77d395 Mon Sep 17 00:00:00 2001 From: Daniel Hong Date: Mon, 8 May 2023 22:20:34 -0400 Subject: [PATCH 2/5] Add punctuation to doc --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 77a4530c..2f4caed5 100644 --- a/README.rst +++ b/README.rst @@ -167,11 +167,11 @@ Hello! Sportsipy is an open source project that welcomes contributors of all bac 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 `_ +`here `_. 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 `_ +`here `_. 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 `_ From a5ea0e0f7f3df3363f24150672ec5f06a74a27c9 Mon Sep 17 00:00:00 2001 From: Daniel Hong Date: Wed, 14 Jun 2023 21:01:54 -0400 Subject: [PATCH 3/5] Add project status update --- README.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.rst b/README.rst index 2f4caed5..b35be112 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,12 @@ Sportsipy: A free sports API written for python **Development Status: This project is no longer undergoing active development. Please consider 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 From e60fd1b39a4abf6ca130b3ec51a485be951d8121 Mon Sep 17 00:00:00 2001 From: Daniel Hong Date: Wed, 14 Jun 2023 21:02:57 -0400 Subject: [PATCH 4/5] Add space between status updates --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index b35be112..48412c64 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,7 @@ Sportsipy: A free sports API written for python **Development Status: This project is no longer undergoing active development. Please consider 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 From 019481495b1be24034cb13bbc44be8ed9d272e63 Mon Sep 17 00:00:00 2001 From: Daniel Hong Date: Wed, 14 Jun 2023 21:04:16 -0400 Subject: [PATCH 5/5] Add punctuation --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 48412c64..5002d573 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,7 @@ maintenance for years, the current version of Sportsipy no longer works as inten 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** +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