ab4io / flowlist

Community curated playlist of songs for coding. An open source project to make your first contribution.

🎶 FLOWLIST 🎶

Masterpieces for the developers 'flow state'

Live Website

What is Flowlist? 😇

A community curated playlist of songs for our coding session. All songs in the list are collected through github contribution. It's meant to encourage collaboration and open source contribution ❤️.

Who can contribute?

• If you have a favorite jam that gets you in the zone and want to share it with fellow developers,
• If you ❤️ to contribute to opensource, this repo is for you.

How to Contribute 🤗

Step 1: Fork the Repository

Click the "Fork" button at the top right of the repository to create a copy of your own.

Step 2: Clone the Repository

Clone the repository you forked to your local machine using the following command:

git clone https://github.com/your-username/flowlist.git

Replace your-username with your GitHub username.

Step 3: Add Your Favorite Jam

Open the data.json file and add your information in the following format:

{
  "username": "your-username",
  "emoji": "😎",
  "favJam": {
    "artist": "Artist Name",
    "title": "Song Title",
    "youtube": "YouTube Link"
  }
}

Replace the placeholder values with your details. You can add as many as 2 songs.
❕Editing or removing current songs is not allowed.❕

Step 4: Create a Branch

Create a new branch for your contribution:

cd flowlist
git checkout -b add-song

Step 5: Commit Changes

Save your changes and commit them:

git add data.json
git commit -m "Add my favorite jam to flowlist"

Step 6: Push Changes

Push your changes to your forked repository:

git push origin add-song

Step 7: Make a Pull Request

Visit your forked repository on GitHub. You will see a 'Compare & pull request' button. Click it to create a pull request. Then your favorite jam will be added to the flowlist!

🎉🥰 Thanks for your contribution 🥰🎉

Happy coding and happy jammin! 🎧