Commit Messages ရေးခြင်း နှင့် မှတ်တမ်းများ ကြည့်ခြင်း

ရည်ရွယ်ချက်

ကောင်းမွန်တဲ့ Commit Message တွေ ရေးတတ်ဖို့နဲ့ Project ရဲ့ Git History တွေကို ဘယ်လို ပြန်ကြည့်ရမလဲ ဆိုတာ နားလည်စေဖို့ ဖြစ်ပါတယ် ခင်ဗျာ။

Project မှာ ဘာတွေ ပြောင်းလဲလိုက်လဲ ဆိုတာကို မှတ်တမ်းတင်တဲ့ နေရာမှာ Commit Message က အရမ်း အရေးကြီးပါတယ်။ နောင်တစ်ချိန် Project ကို ပြန်ကြည့်တဲ့အခါ ဘာတွေ ဖြစ်ခဲ့လဲ ဆိုတာ အလွယ်တကူ သိနိုင်အောင် Message ကောင်းကောင်း ရေးဖို့ လိုပါတယ်။ “တစ်ခုခု ပြင်လိုက်တယ်” ဆိုတဲ့ ယေဘုယျဆန်တဲ့ Message မျိုးတွေက နားလည်ရ ခက်ခဲစေပါတယ်။

Commit Message ကောင်းကောင်း ရေးနည်း

Commit Message ရဲ့ ပထမဆုံး စာကြောင်းကို အတိုချုပ်နဲ့ ရှင်းရှင်းလင်းလင်း ရေးပါ။ ဥပမာ - “Login feature ထည့်ခြင်း” သို့မဟုတ် “README စာလုံးပေါင်း မှားတာ ပြင်ခြင်း” လိုမျိုး တိတိကျကျ ရေးတာ ပိုကောင်းပါတယ်။ စာကြောင်းအဆုံးမှာ အစက် (.) မလိုဘဲ စာလုံးရေ ၅၀ လောက်သာ ရေးဖို့ အကြံပြုချင်ပါတယ်။ (ဥပမာ: ❌ “fixed stuff” ထက် ✅ “Fix user login bug” ဆိုတာမျိုးက ပိုကောင်းပါတယ်။)

Tip

ပိုကောင်းတဲ့ Commit Message တွေ ရေးဖို့ conventionalcommits ကို ကြည့်ရှု လေ့လာနိုင်ပါတယ်။

Project သမိုင်းကြောင်း ကြည့်ခြင်း (git log)

Project ရဲ့ အရင်က Commit လုပ်ထားတဲ့ မှတ်တမ်းတွေ အားလုံးကို ပြန်ကြည့်ချင်ရင် Terminal မှာ git log Command ကို ရိုက်ကြည့်ပါ။ ဘယ်သူက၊ ဘယ်နေ့က၊ ဘာ Message နဲ့ လုပ်ခဲ့တယ် ဆိုတာကို အစအဆုံး ပြပေးပါလိမ့်မယ်။ (မှတ်တမ်းတွေ အများကြီး ရှိနေရင် Keyboard က ‘q’ ကို နှိပ်ပြီး ထွက်နိုင်ပါတယ်)။

git log --oneline ကို သုံးရင်တော့ Commit တစ်ခုစီကို တစ်ကြောင်းတည်းနဲ့ အတိုချုပ် မြင်ရမှာ ဖြစ်ပါတယ်။

ကိုယ်တိုင် လုပ်ကြည့်ဖို့: README.md ဖိုင်ကို ထပ်ပြင်ပြီး git add, git commit လုပ်ကြည့်ပါ။ ပြီးရင် git log နဲ့ git log --oneline ကို ရိုက်ကြည့်ပါ။

မလိုအပ်တဲ့ ဖိုင်အချို့ကို ချန်ထားခြင်း (.gitignore)

Project ထဲမှာ Git မှတ်တမ်းတင်ဖို့ မလိုအပ်တဲ့ ဖိုင်တွေ ရှိတတ်ပါတယ်။ ဥပမာ - Compile လုပ်လို့ ထွက်လာတဲ့ ဖိုင်တွေ၊ Library Folder တွေ (node_modules) နဲ့ API Key လို လုံခြုံရေး အချက်အလက်တွေ ဖြစ်ပါတယ်။ ဒီလို ဖိုင်တွေကို Git မှတ်တမ်းထဲ မပါအောင် ချန်ထားခဲ့တာက Project ကို သန့်ရှင်းနေစေပြီး မလိုအပ်ဘဲ File Size ကြီးမလာအောင် ကာကွယ်ပေးပါတယ်။

.gitignore File အသုံးပြုခြင်း

Git ကနေ လျစ်လျူရှုရမယ့် ဖိုင်တွေ၊ Folder တွေကို .gitignore လို့ အမည်ပေးထားတဲ့ File တစ်ခုထဲမှာ ရေးမှတ်ထားရပါတယ်။ ဒီဖိုင်ကို Project ရဲ့ Root Folder မှာ ထားရပါမယ်။

ဥပမာ -

• node_modules/ (Folder တစ်ခုလုံးကို ချန်ခဲ့မည်)
• *.log (.log နဲ့ ဆုံးတဲ့ ဖိုင်အားလုံးကို ချန်ခဲ့မည်)
• secrets.txt (ဒီဖိုင် တစ်ခုတည်းကို ချန်ခဲ့မည်)

ကိုယ်တိုင် လုပ်ကြည့်ဖို့: my-first-repo ထဲမှာ .gitignore ဖိုင်ဆောက်ပြီး *.log လို့ ရေးထည့် Save ပါ။ ပြီးရင် debug.log ဖိုင်သစ်တစ်ခု ထပ်ဆောက်ပြီး git status စစ်ကြည့်ပါ။ debug.log ပေါ်မလာဘဲ .gitignore ဖိုင်ပဲ ပေါ်နေရင် မှန်ကန်ပါတယ်။

Team ဝင်တိုင်း ဘယ်ဖိုင်တွေကို ချန်ထားရမလဲ ဆိုတာ အတူတူ သိနိုင်ဖို့အတွက် .gitignore ဖိုင် ကိုယ်တိုင်ကိုလည်း Commit လုပ်ပြီး မှတ်တမ်းတင်ထားသင့်ပါတယ် ခင်ဗျာ။ (ဥပမာ - git add .gitignore ပြီးရင် git commit -m "chore: add .gitignore")