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

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

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

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

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

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

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

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

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

`.gitignore` file

Git ကနေ ဘယ်ဖိုင်တွေ၊ ဘယ် Folder တွေကို လျစ်လျူရှုရမလဲဆိုတာကို .gitignore လို့ အမည်ပေးထားတဲ့ Text File တစ်ခုထဲမှာ ရေးမှတ်ထားရပါတယ်။ ဒီဖိုင်ကို Project ရဲ့ အဓိက Folder ထဲမှာ ထည့်ထားရပါမယ်။ ဖိုင်ထဲမှာ တစ်ကြောင်းစီက လျစ်လျူရှုချင်တဲ့ ဖိုင် ဒါမှမဟုတ် Folder ပုံစံ (Pattern) တစ်ခုစီပါ။ ဥပမာ- node_modules/ ဆိုရင် အဲဒီ Folder ထဲက အရာအားလုံးကို ချန်ခဲ့မယ်၊ *.log ဆိုရင် .log နဲ့ ဆုံးတဲ့ ဖိုင်အားလုံးကို ချန်ခဲ့မယ်၊ secrets.txt ဆိုရင် အဲဒီဖိုင်ကို ချန်ခဲ့မယ်ပေါ့။

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

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