HDL_workflow/git_checklist.mdwn

   1 # git checklist
   2
   3 When using git this is a reminder of commands to run and best practices
   4 If you are very new to git, you would want to read [a really quick intro to git](/HDL_workflow/git_intro) first.
   5
   6 ## what to do if you want to modify some pages
   7
   8 Here is the checklist for making changes.
   9
  10 [[!template id=note text="""If you do not intend to complete
  11 the work right the way through to "git push" immediately (at least by the end
  12 of the day), or do not "have time", reconsider and find a way to make the work
  13 smaller. If unsure, ask on the mailing list."""]]
  14
  15 * run `git pull`
  16 * edit files, making sure only one “purpose"
  17 * save them
  18 * run unit tests and make sure they pass
  19 * fix errors
  20 * run `git status | more`, review the output
  21 * run `git diff`, review the output
  22 * run `git commit -a -m 'useful description' `
  23 * run `git pull`
  24 * run `git push`
  25
  26 # Troubleshooting
  27 ## [[!toggle  id="conflict" text="""what to do if "git pull" results in conflict"""]]
  28
  29 [[!toggleable  id="conflict" text="""
  30 * to be done
  31 * if you are still unsure what to do please ask for advice on IRC or the
  32 mailing list
  33
  34 [[!toggle id="conflict" text="hide"]]
  35 """]]
  36
  37 ## [[!toggle  id="add" text="""what to do if you want to add files."""]]
  38
  39 [[!toggleable  id="add" text="""
  40 * to be done
  41 * if you are still unsure what to do please ask for advice on IRC or the
  42 mailing list
  43
  44 [[!toggle id="add" text="hide"]]
  45 """]]
  46 ---
  47
  48 this one, `git status` is very important, to check files that should have
  49 been added but have not.