Project name (RANDOM MEAL GENERATOR)


Steps for contributing to this repo

  1. Fork the repo
  2. Clone the repo
  • click the Clone/Code button
  • then copy the repo url or download the zip folder
  • if you copied the repo url
  • open your command line or git bash or whatever you have
  • Use git clone (the url you copied) command
  • use cd (the name of the folder you cloned)
  • then create your own branch with git checkout -b (name of your branch)
  • then you can add your own changes in the file
  1. after making your contribution
  • use git add . to stage your changes
  • then git commit -m "(your commit msg here)" the steps of a commit msg will be mark down below
  • then git checkout master
  • git push origin (the name of the branch you want to merge)
  • Go to the repo on Github(the one your forked) and click new pull request button
  • create a pull request and leave a comment
  • then wait for your pull request to be accepted
  1. if after this you still do understand how to collaborate on github, then watch this video collaborating on Github

Steps for writing an acceptable commit msg

  • although git commit -m "message here" is not advisable, we will use it for the sake of speed and the bias that its a small project
  • in your msg answer this questions
  1. Why is your change necessary
  2. how does it address the issue
  3. What side effect does your change have

you changes might not always be inline with the above just make sure you add a good commit message

an example of a commit msg git commit -m "make button red for accessiblity of people with poor sight"