Kunleodusan / insurance-policy-app

0 stars 0 forks source link

Get comfortable creating a Pull Request #11

Closed Kunleodusan closed 4 years ago

Kunleodusan commented 4 years ago

This ticket is used to demonstrate the git workflow using the terminal to create push your code. There are a number of tutorials online that can help as well. Here's a link to a short description.

First you'll need to install git on your machine. Hit me up if you run into any issues installing git. I'm happy to go through this with you.

The steps include:

  1. Clone the repository (Would only need to do this once). 🤓 e.g git clone https://github.com/Kunleodusan/insurance-policy-app.git

Then change directory into the repository folder: cd insurance-policy-app

  1. Creating a branch name with issue number & set to track the master branch. git checkout -b #BRANCH-NAME -t origin/master 🌴 . Where #BRANCH-NAME follows format issue-#ISSUE-ID The issue id is written beside the issue title. For example, issue id is 5 in this issue. If the ticket you were working on has an id of 1, the branch name would beissue-1 for this ticket. e.g git checkout -b issue-1 -t origin/master.

  2. Write your code. 👨‍💻

    • [ ] There's a README.md file in each directory. Add your name to the contributors list in the root, server & client directory README.md file respectively.
  3. Add changed files. git add #file_or_folder_name

  4. Commit your changes. (commit message to follow format: git commit -m"fix #ISSUE-ID: description") For example: git commit -m"fix #1 : creating a pull request" 🗒️

  5. Push your changes git push origin #BRANCH-NAME. For example git push origin issue-1🚀

  6. Make a pull request & add @Kunleodusan as a reviewer. ♻️

  7. Pull request goes through review & is approved. 👍

  8. Pull request build passes (to be implemented). ✅

  9. Pull request gets merged. 🎉

  10. Merge deploys automatically to our servers (to be implemented). 🌐