From 23515aaf02b1e5658231d8a82280c94ffb86b96d Mon Sep 17 00:00:00 2001 From: Samuel St Jean <92886388+samuel-stjean@users.noreply.github.com> Date: Sun, 1 Oct 2023 16:18:27 -0400 Subject: [PATCH 1/2] Update README.md Table of contents added to README.md and steps for contributions. --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb50ea3..2781a17 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ This program will search for spotify tracks posted in the HipHopHeads subreddit and add them to a playlist of your choice. HipHopHeads is a subreddit dedicated to everything hiphop, including the latest mixtapes, videos, news, and anything else hip hop related from your favorite artists. +# Table of Contents +[New features](https://github.com/samuel-stjean/fresh_script#new-features) +[Getting Started](https://github.com/samuel-stjean/fresh_script#getting-started) + - [Prerequisites](https://github.com/samuel-stjean/fresh_script#prerequisites) + - [Setup your Credentials](https://github.com/samuel-stjean/fresh_script#setup-your-credentials) + - [Installing dependencies](https://github.com/samuel-stjean/fresh_script#installing-dependencies) + - [Running the script](https://github.com/samuel-stjean/fresh_script#running-the-script) + - [Script arguments](https://github.com/samuel-stjean/fresh_script#script-arguments) + - [Running the script using cron](https://github.com/samuel-stjean/fresh_script#running-the-script-using-cron) +[Contributing](https://github.com/samuel-stjean/fresh_script#contributing) + ## New Features! [Flask](http://flask.pocoo.org/) has recently been added to the project. You can read up on how to get it setup [here](flask.md). @@ -106,4 +117,16 @@ We can use cron to automatically run the script periodically in order to keep it ## Contributing -I appreciate any help and support. Feel free to [fork](https://github.com/amcquade/fresh_script#fork-destination-box) and [create a pull request](https://github.com/amcquade/fresh_script/compare) +1. [Fork](https://github.com/amcquade/fresh_script#fork-destination-box) the Repository: Start by forking the project's repository to your GitHub account. This creates a copy of the project that you can freely modify. [tutorial](https://www.youtube.com/watch?v=l5NrYIa_aG4&pp=ygUWZm9yayByZXBvc2l0b3J5IGdpdGh1Yg%3D%3D) + +2. [Clone](https://www.youtube.com/watch?v=TBoS5Qbv89o&pp=ygUVY2xvbmUgYSBmb3JrIHRvIGxvY2Fs) Your Fork: Clone your forked repository to your local development environment using `git clone`. + +3. Create a [Branch](https://www.youtube.com/watch?v=snxybJkFeUo&pp=ygUVY3JlYXRlIGEgYnJhbmNoIGxvY2Fs): Create a new branch for your contribution. Please use a descriptive name. + +4. Make & Document Changes: Make your desired changes or additions to the codebase, update the documentation, comments, or README files. + +5. [Commit & Push](https://www.youtube.com/watch?v=lYiE5lBS13E&pp=ygUPY29tbWl0IGFuZCBwdXNo) Your Changes: Commit your changes with a clear and concise commit message that describes what your changes accomplish and push your branch with your changes to your GitHub fork. + +6. [Create a Pull Request](https://github.com/amcquade/fresh_script/compare): Go to the original project's repository and create a new Pull Request from your forked branch. Provide a clear description of your changes in the PR description. + +I appreciate any help and support. Thank you! From 3e96205259628a862668ef3c7161ff5faf1cb61a Mon Sep 17 00:00:00 2001 From: Samuel St Jean <92886388+samuel-stjean@users.noreply.github.com> Date: Sun, 1 Oct 2023 16:25:07 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2781a17..f51ad0e 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,15 @@ This program will search for spotify tracks posted in the HipHopHeads subreddit and add them to a playlist of your choice. HipHopHeads is a subreddit dedicated to everything hiphop, including the latest mixtapes, videos, news, and anything else hip hop related from your favorite artists. # Table of Contents -[New features](https://github.com/samuel-stjean/fresh_script#new-features) -[Getting Started](https://github.com/samuel-stjean/fresh_script#getting-started) +1) [New features](https://github.com/samuel-stjean/fresh_script#new-features) +2) [Getting Started](https://github.com/samuel-stjean/fresh_script#getting-started) - [Prerequisites](https://github.com/samuel-stjean/fresh_script#prerequisites) - [Setup your Credentials](https://github.com/samuel-stjean/fresh_script#setup-your-credentials) - [Installing dependencies](https://github.com/samuel-stjean/fresh_script#installing-dependencies) - [Running the script](https://github.com/samuel-stjean/fresh_script#running-the-script) - [Script arguments](https://github.com/samuel-stjean/fresh_script#script-arguments) - [Running the script using cron](https://github.com/samuel-stjean/fresh_script#running-the-script-using-cron) -[Contributing](https://github.com/samuel-stjean/fresh_script#contributing) +3) [Contributing](https://github.com/samuel-stjean/fresh_script#contributing) ## New Features! [Flask](http://flask.pocoo.org/) has recently been added to the project. You can read up on how to get it setup [here](flask.md).