Contributing - alan7383/playify GitHub Wiki

Help Us Grow! 🌱

Playify is an open-source project, and we love it when the community helps make it better! Thank you for your interest in contributing. (´♡‿♡`)

There are many ways to contribute, even if you don't write code.

Reporting Bugs (Bug Busters! ૮( ✘'ω' )ა)

If you find a problem, please check the Troubleshooting page first. If it's a new bug, open a detailed issue. A good bug report saves us a lot of time!

Suggesting Features (Idea Factory! ૮💡ﻌ💡ა)

Have a cool idea for a new command or feature? We'd love to hear it! Please open a feature request issue and tell us all about your idea.

Submitting Code (Pull Requests ૮₍ •̀ω•́ ₎ა)

If you'd like to write some code, we welcome your pull requests! Here’s the general workflow:

  1. Fork the repository: Click the "Fork" button at the top right of the main project page. This creates a copy of the project under your own GitHub account.

  2. Clone your fork: On your local machine, run:

    git clone https://github.com/YOUR-USERNAME/playify.git
cd playify

  3. Create a new branch: Always create a new branch for your changes. Give it a descriptive name.

    git checkout -b my-awesome-new-feature

  4. Make your changes: Write your amazing code! Try to follow the existing code style to keep everything consistent and clean.

  5. Test your changes: Please make sure your code works as expected and doesn't break anything else.

  6. Commit and push: Commit your changes with a clear message and push them to your fork.

    git add .
git commit -m "feat: Add my awesome new feature"
git push origin my-awesome-new-feature

  7. Open a Pull Request: Go back to your fork on GitHub and click "New pull request". Write a clear title and description explaining what your changes do and why they are needed. If it fixes an existing issue, be sure to mention it (e.g., "Fixes #123").

We will review your PR as soon as we can. We might suggest some changes or improvements. ( ´ ▽ ` )b

Thank you again for making Playify better! We appreciate every contribution, big or small! ♡