READMEの書き方|最低限の4つとスクショ・GIFの貼り方
GitHubに個人開発を上げている学生・初心者向けに、READMEに最低限書く4要素(概要・使用技術・セットアップ手順・.env.exampleの案内)と最小テンプレ、スクリーンショットをIssueの入力欄や相対パスで貼る方法、画面録画をffmpegで軽いGIFにする手順をまとめた。
GitHubに個人開発を上げている学生・初心者向けに、READMEに最低限書く4要素(概要・使用技術・セットアップ手順・.env.exampleの案内)と最小テンプレ、スクリーンショットをIssueの入力欄や相対パスで貼る方法、画面録画をffmpegで軽いGIFにする手順をまとめた。
Obsidianのノートを無料で同期しながら変更履歴も残せる、Gitを使った同期の手順をまとめました。リポジトリの作成からGitHubへの接続、Gitプラグインでの自動化、多くの記事が書いていないコンフリクト(衝突)の直し方まで、コマンド付きで説明します。iPhone・Androidでの制約と、リポジトリを非公開にすべき理由も扱います。
git aliasの作り方(git config --global alias.co checkout の1行)から、co・st・br・ci・df・lgの定番6つの登録コマンド、一覧の確認と消し方まで。張りすぎると逆に困る理由と「頻度が高い×打つのが長い」ものだけ張る判断基準、危険な操作を短縮しない理由も書いた。
コミットメッセージが「fix」「update」になりがちな学生・個人開発者向けに、git diffをOllamaのローカルLLMにパイプで渡して書かせる最短の1行、Conventional Commitsで揃えるプロンプトの型、シェル関数化、prepare-commit-msgフックでの半自動化までまとめた。
git configはlocal・global・systemの3層で、同じキーは範囲の狭いlocalが優先される。user.nameやaliasをどの層に置くか、--show-originで設定の出どころを確かめる方法、cloneしてもlocalは配られない落とし穴まで。
gitのpre-commitフックの仕組み(終了コードが0以外ならコミット中断)と、.envや*.keyがステージされていたらコミットを止めるコピペで動く最小スクリプト、chmod +xとテストの手順、lint自動実行への広げ方、--no-verifyとcore.hooksPathの落とし穴までまとめた。
.gitignoreに最初に書くのは.env・node_modules/・.venv/・__pycache__/・.DS_Store・.vscode/の6行。各行が防ぐこと、.envを上げてはいけない理由、もう上げたファイルをgit rm --cachedで追跡から外す手順まで。
VS Codeのマルチルートワークスペースを使うと、フロントとバックエンドなど複数のフォルダを1つのウィンドウで開ける。Add Folder to Workspaceからの作り方、.code-workspaceの中身、フォルダごとの設定と効かない設定まで。