#git #github #hardware
This will be a thorough walkthrough of some common git commands like git commit, git branch, git log, git submodules, git tags, and git hooks with a simple KiCad project and Arduino firmware files. We will also push the local repository to GitHub and explore some GitHub features such as tags, pull requests, adding messages that can change some GitHub status of closing the raised bugs.
⏰ TIMESTAMPS
0:00 Intro
02:22 git commit
07:37 git log
09:50 git submodules
12:53 git branch
22:25 git hooks
24:31 git tags
29:15 semantic versioning
30:50 Outro
‣ Some links below are affiliate. I receive a small commission at no extra cost to you.
🎩 DEMO FILES
git shortcuts https://github.com/sayanee/dotfiles/blob/master/zshrc#L32-L40
🔗 LINKS SHOWN
An Introduction to Git for Hardware with Altium Designer | Blogs | Altium https://resources.altium.com/p/introduction-git-altium-designer
AllSpice: Hardware Development Tools for Electrical Engineers https://www.allspice.io/
File Formats | KiCad EDA https://kicad.org/help/file-formats/
gitignore/KiCad.gitignore at master · github/gitignore https://github.com/github/gitignore/blob/master/KiCad.gitignore
Automating Fabrication Outputs With KiCad And Git - Jesse Vincent (KiCon 2019) - YouTube https://www.youtube.com/watch?t=918&v=NZCyk3rmmGQ
obra/kicad-tools: Various bits of automation for using KiCAD and Git together https://github.com/obra/kicad-tools
productize/kicad-automation-scripts: A bunch of scripts to automate KiCad processes https://github.com/productize/kicad-automation-scripts
xesscorp/skidl: SKiDL is a module that extends Python with the ability to design electronic circuits. https://github.com/xesscorp/skidl
Conventional Commits https://www.conventionalcommits.org/en/v1.0.0/#summary
Conventional Changelog Action · Actions · GitHub Marketplace https://github.com/marketplace/actions/conventional-changelog-action
version control - Is it better to merge "often" or only after completion do a big merge of feature branches? - Software Engineering Stack Exchange https://softwareengineering.stackexchange.com/questions/395021/is-it-better-to-merge-often-or-only-after-completion-do-a-big-merge-of-feature
Linking a pull request to an issue - GitHub Docs https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
Creating a commit with multiple authors - GitHub Docs https://docs.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line
About pull requests - GitHub Docs https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
awslabs/git-secrets - Prevents you from committing secrets and credentials into git repositories https://github.com/awslabs/git-secrets
Semantic Versioning 2.0.0 | Semantic Versioning https://semver.org/
hardware-semantic-versioning [qyx.krtko.org] http://qyx.krtko.org/wiki/hardware-semantic-versioning
🔌 TOOLS USED
https://hutscape.com/tools
🎶 MUSIC AND SOUND EFFECTS
New Morning by Tracktribe from YouTube Audio Library https://www.youtube.com/watch?v=SXzKrU9Ykg0