(no commit message)

[libreriscv.git] / HDL_workflow / git_checklist.mdwn

diff --git a/HDL_workflow/git_checklist.mdwn b/HDL_workflow/git_checklist.mdwn
index d17d35dd946af69d9e604e8525377688a4f3207a..b1260178f6011882a7f42e8a5344c728d34747aa 100644 (file)
--- a/HDL_workflow/git_checklist.mdwn
+++ b/HDL_workflow/git_checklist.mdwn
@@ -11,3 +11,39 @@ Here is the checklist for making changes.
 the work right the way through to "git push" immediately (at least by the end
 of the day), or do not "have time", reconsider and find a way to make the work
 smaller. If unsure, ask on the mailing list."""]]
+
+* run `git pull`
+* edit files, making sure only one “purpose"
+* save them
+* run unit tests and make sure they pass
+* fix errors
+* run `git status | more`, review the output
+* run `git diff`, review the output
+* run `git commit -a -m 'useful description' `
+* run `git pull`
+* run `git push`
+
+# Troubleshooting
+## [[!toggle  id="conflict" text="""what to do if "git pull" results in conflict"""]]
+
+[[!toggleable  id="conflict" text="""
+* to be done
+* if you are still unsure what to do please ask for advice on IRC or the
+mailing list
+
+[[!toggle id="conflict" text="hide"]]
+"""]]
+
+## [[!toggle  id="add" text="""what to do if you want to add files."""]]
+
+[[!toggleable  id="add" text="""
+* to be done
+* if you are still unsure what to do please ask for advice on IRC or the
+mailing list
+
+[[!toggle id="add" text="hide"]]
+"""]]
+---
+
+this one, `git status` is very important, to check files that should have
+been added but have not.