Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 2.63 KB

USAGE.md

File metadata and controls

45 lines (37 loc) · 2.63 KB
Raw

Gitg0 Usage

  • Before you start working on your project, set up the .gitgo file:

    • Run gtg config
    • Choose a commit guideline for your project: commit_guideline_image
    • Choose if you want emojis: emoji_usage_image
    • A .gitgo file will be generated in your working directory!

  • Now, whenever you work on a new feature/issue:

    • Run gtg start
    • Either enter your Github Issue Number: github_issue_number_image or manually type what you're working: manual_issue_text_image
    • After we fetch your Github Issue title or process your manually entered text, select the Issue type: issue_type_mcq_image

  • To see suggested Branch Name and Commit Title:

    • Run gtg display: suggested_names_image
    • You can also modify the suggested names by simply entering the text: modifying_suggested_name_image

  • To checkout to the suggested Branch Name:

    • Run gtg checkout: checkout_branch_image

  • Make relevant changes to your code for your issue.

  • To add all changes in the working directory to the staging area (conventional git stuff):

    • Run git add .
    • [Optional] Run git status to check the state of the working directory: git_add_and_git_status_image

  • To commit changes with the Gitg0's suggested commit message:

    • Run gtg commit: gtg_commit_image
    • [Optional] Run git log to ensure that the changes have been commited.

  • To push your changes:

    • Run git push: git_push_image

  • Voila! You're GTG: Good to go.