Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.92 KB

CONTRIBUTE.md

File metadata and controls

73 lines (45 loc) · 2.92 KB

How To Contribute

Step 1: Forking the repository

To work on this project, you will first need to make a copy of this repository. To do this, you should fork the repository and then clone it so that you have a local working copy.

Get your own Fork/Copy of this repository by clicking Fork button at right upper corner of your screen.

fork

Step 2: Clone the Forked Repository

After forking the repository, you can now clone it to have a local working copy of the codebase.

To make your local copy of the repository follow the steps:

  • Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

68747470733a2f2f6669727374636f6e747269627574696f6e732e6769746875622e696f2f6173736574732f526561646d652f636c6f6e652e706e67 68747470733a2f2f6669727374636f6e747269627574696f6e732e6769746875622e696f2f6173736574732f526561646d652f636f70792d746f2d636c6970626f6172642e706e67

Open a terminal in a blank folder where you would like to store the project and run the following git command:

git clone <url>

where is the url (without the <>) to this repository aka your fork of this project. See the previous steps to obtain the url.

Step 3: Make your changes

Now you can see all the files in your local system and begin making changes.

Step 4: Commit your changes

  • Track your changes:
git add .
  • Commit your changes
git commit -m "Relevant message"
  • Push the committed changes in your feature/main branch to your remote repo.
git push origin <your_branch_name/main>

Step 5: Create Pull Request

Now visit mood-colors repository which you forked.

  • Click on where it says X commit ahead
  • To create a pull request, click on Create pull request. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
  • Add appropriate title and description to your pull request explaining your changes and efforts done. Best practice is to include an image of the changes that were made if changes were visual.
  • Click on Create Pull Request.

🎉 Kudos! You have made a PR! Sit back patiently and relax while your PR is reviewed and merged. Thank you for your contribution!

To update your local repository on your local machine:

  • On GitHub, navigate to the main page of the forked repository that you want to sync with the upstream repository. Alt text
  • On your terminal, pull the forked repo that is now synced.
git pull origin main