Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 2.06 KB

Welcome to the MLSA UET PESHAWAR Contributing guide

Please read out all of the mentioned details of this document in order to get a successful pull request merged.

Contribution Rules📚:

  • You are allowed to make pull requests that break the rules. We just merge it ;)
  • Pull requests should me meaning ful
  • Pull Request should be your own work
  • Plagirism and spamming of any sort is not allowed
  • 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
  • Add your name to the contributorsList file
  • Try to keep pull requests small to minimize merge conflicts

Anyone found not living up to the hacktoberfest spirit and violating the rules will be flagged and it will damage your profile.

Getting Started 🤩🤗:

  • Fork this repo (button on top)
  • Clone on your local machine
git clone https://github.com/MLSA-UETP/HacktoberFest-22
  • Navigate to project directory.
cd HacktoberFest-22
  • Create a new Branch
git checkout -b my-new-branch
  • Add your Name to contributors/contributorsList.js
git add .
  • Commit your changes.
git commit -m "Relevant message"
  • Then push
git push origin my-new-branch
  • Create a new pull request from your forked repository

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/MLSA-UETP/HacktoberFest-22

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

git remote -v

To pull any new changes from your parent repo 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.