fire2a-on-boarding

git

main usage

git clone git@github.com:fire2a/C2F-W.git
cd C2F-W

# alternative A
git pull
# B
git fetch 
git switch [-c] branch-name-is-at-least-a-half-sentence-explaining-the-feature/issue [main]

git diff
git add new_or_changed_text_file
git commit -m "sentence that explains the purpose of the change"

git push [--set-upstream origin my-feature-branch]

# contribute
firefox https://github.com/fire2a/C2F-W/compare/main...my-feature-branch

secondary

git status
git log
git branch -a
git remote -v

A learning path

1. (what is git again?) watch any video introduction, or play the game: https://ohmygit.org/
2. (novice) Get started with GitHub documentation
3. (do once) SSH Authentication
4. (essential, must be understood) Contributing to a project
5. official docs: really good cheat sheets and official manual
6. Learn how your IDE implements git (example: VSCode or Unix is my IDE); to do interactive and/or visual diffs.

further research

• setup .gitconfig
• view differences: diff between branches, commits, tags...
• search into the whole tree git log --grep <regex> [branches]
• merge; branches, 2-3 way
• cherry-pick
• git remote set-url origin git@...
• never git reset ...
• search all code (all branches) git grep -e 'your_search_string' $(git rev-list --all)

coding practices 0

• the best code/document is not the smartest one, but the most legible
• write/name everything as for your future self, when you'd forgotten about it & context
• avoid typing errors by typing as little as possible vs copy/paste

our github organization

1. Every team member has write as default privileges. Be respectful of other people branches
2. When creating a new public repo (can't be done with private), create a protection rule for the main branch:
   • requiring pull requests
   • disallowing push
   

Intro to cli

• https://blog.sanctum.geek.nz/series/unix-as-ide/
• https://www.geeksforgeeks.org/linux-tutorial/