Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (67 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

94 lines (67 loc) · 2.53 KB

Contribution Rules📚:

  • You are allowed to make more than one pull request. We'll merge surely merge the perfect ones :)
  • Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
  • Do NOT remove other content.
  • Styling/code can be pretty, ugly or stupid, big or small as long as it works 😉
  • Make sure your create a separate branch before opening a PR.
  • Try to keep pull requests small to minimize merge conflicts

Getting Started 🤩🤗:

  • Fork the repository
  • Clone your forked repository:
git clone https://github.com/<your-github-username>/BeatBridge.git
  • Navigate to the project directory:
cd BeatBridge
  • Install dependencies:
npm install

  • Setup Environment Variables

    • Create a file .env.local in the root directory.
    • Go to Spotify Dashboard and Login into your Spotify Account.
    • Create an App and fill the required details like Name, Description, Website
    • Make sure to add the Redirect URI to https://localhost:5173 and check the following API image
    • Save the Details, Click on the App you just created and go to Settings
    • Copy your CLIENT_ID and CLIENT_SECRET
    • Add the following in the .env.local file.
    • VITE_CLIENT_ID=your_client_id
VITE_CLIENT_SECRET=your_client_secret

  • Start the development server:

npm run dev
  • Create a new branch for your contribution:
git checkout -b your-username
  • Make your changes in the specific folder in ./src/Components and commit them:
git commit -m "Added a transition"
  • Push your changes to your fork:
git push origin your-username
  • Create a Pull Request to the master repository!
  • Get your PR merged 🚀

Avoid Conflicts {Syncing your fork}

An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork.

git remote add upstream https://github.com/pooranjoyb/BeatBridge

You can verify that the new remote has been added by typing

git remote -v

To pull any new changes from your parent repository simply run

git merge upstream/master

This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent.