correctly formatted the text.
authormePy2 <mePy2@web>
Sun, 28 Mar 2021 20:21:17 +0000 (21:21 +0100)
committerIkiWiki <ikiwiki.info>
Sun, 28 Mar 2021 20:21:17 +0000 (21:21 +0100)
HDL_workflow/git_checklist.mdwn

index 0cea45a27c1909627a0aa15542ce2da70b7df7df..e0f37d88f3cb707415eac0ee6fe8299c368fce27 100644 (file)
@@ -5,30 +5,34 @@
 when using git this is a reminder of commands to run and best practices
 
 ## How does working with git looks like
-- You download a directory with project files in it
-- Modify some files, add others
-- Upload your work so other can take advantage of it
+* You download a directory with project files in it
+* Modify some files, add others
+* Upload your work so other can take advantage of it
 
-In git you do this by
-- *Cloning* a repository (aka downloading stuff)
-- *Committing* your local changes (aka you "take note" of what you did. e.g. modified some files, added new files, deleted some files and so on)
-- *Pushing* your work online (aka uploading online)
+In git you do this by:
 
-## Cloning
-(optional) `cd ` + somewhere in your disk
+* *Cloning* a repository (aka downloading stuff)
+* *Committing* your local changes (aka you "take note" of what you did. e.g. modified some files, added new files, deleted some files and so on)
+* *Pushing* your work online (aka uploading online)
 
+## Cloning
+(optional) `cd ` + somewhere in your disk  
 `git clone ` + repo url
 
 ## Making changes
-// You know what to do
+*// You know what to do*
 
 ## Committing
 `git add` + files you want to "take note" of.
 
-E.g. `git add test.png` will take note of the “test.png" file for when you will want to commit your work. (Committing your work is like saving in a videogame. When you are good with what you have done, you save the stage of your "enjoyment").
+E.g. `git add test.png` will take note of the “test.png" file for when you will want to commit your work. (Committing your work is like saving in a videogame. When you are good with what you have done, you save the stage of the adventure).
 
-When committing you are required to add a comment to your "save file" (commit).
-Like "I added the test.png file".
+When committing you are required to add a comment to your "save file" (commit).  
+Like ~~"I added the test.png file"~~.  
+Ahah, I was kidding. Remember:  
+> the git message is for WHY you did what you did.
+> 
+> not what ACTION was done on what file.
 
 ## Pushing
 When you are done committing all your stuff, you want to share it with other. So you push on the remote repository (directory).
@@ -38,9 +42,10 @@ So you just `git push`.
 
 ### Notes 1
 Pay attention to:
-- what you modify in the repository
-- what files you add to your commit
-- when pushing, what are you actually pushing
+
+* what you modify in the repository 
+* what files you add to your commit
+* when pushing, what are you actually pushing
 
 ### Notes 2
 When doing `git commit` best thing to do is to add ` -m "<comment here, without brackets>"`
@@ -50,10 +55,11 @@ Like this: `git commit -m "added test.png"`.
 If you omit the -m option, a text editor will appear to let you insert a commit message. Sometimes is useful to let git open the editor. e.g. for long comments or comments with quotes in it.
 
 If `vim` editor opens (you get stuck into something you do not know how to exit from), remember:
-- type `i` to "insert text".
-- when you are doing typing some text, press the esc key on the keyboard
-- if you want to save the comment/text, press `w` (means "write")
-- to quit, press `q`
-You are done. 
 
+* type `i` to "insert text".
+* when you are doing typing some text, press the esc key on the keyboard
+* if you want to save the comment/text, press `w` (means "write")
+* to quit, press `q`
+
+You are done.  
 To quit without saving/writing: `q!` (e.g. you want to exit)