অধ্যায় 4 · ডিজাইন ও কোড
কোড রিভিউ, ভার্সন কন্ট্রোল ও টিমের কাজের ধারা
- পৃষ্ঠা 14 / 18
- 15 মিনিট পড়া
ফারহান যখন একা প্রথম প্রোটোটাইপে কাজ করতেন, তখন যেকোনো সময় যেকোনো ফাইল বদলাতে পারতেন। এখন চারজন মানুষ প্রতিদিন ClinicQueue বদলান। ভাগ করা অভ্যাস না থাকলে আইকোর পরিবর্তন ফারহানেরটা মুছে দেয়, আধা-শেষ ফিচার ক্লিনিকে পৌঁছে যায়, আর কেউ মনে রাখে না একটা লাইন কেন বদলানো হয়েছিল। টিমের কাজের ধারা (team workflow) হলো সেই অভ্যাসগুলো, যা এটা ঠেকায়: প্রতিটা পরিবর্তন থাকে নিজস্ব ব্রাঞ্চে, আরেকজন সেটা রিভিউ করেন, আর মূল কোড সবসময় এমন অবস্থায় থাকে যে চাইলেই রিলিজ করা যায়।
আগের পাতা রক্ষণাবেক্ষণযোগ্য কোড লেখা-তে আপনি একটা ফাংশনকে পড়া আর বদলানো সহজ করেছেন। এই পাতা হলো একটা টিম কীভাবে এমন পরিবর্তন একজনের ল্যাপটপ থেকে নিরাপদে ভাগ করা প্রোডাক্টে নিয়ে আসে, তা নিয়ে। Git-এর কমান্ডগুলো নিজেই শেখানো হয়েছে AI-এর জন্য Git, API ও ব্যাকএন্ড: বিগিনার-এ; এখানে মনোযোগ সেগুলো ঘিরে টিমের অভ্যাসে। সব নাম, ইস্যু নম্বর আর ব্রাঞ্চের নাম কাল্পনিক।
যা শিখবেন
- টিমগুলো কেন কোড রিভিউ করে, আর একজন রিভিউয়ার আসলে কী যাচাই করেন।
- কীভাবে সম্মানের সাথে রিভিউ কমেন্ট দেবেন আর নেবেন, আর ছোট পুল রিকোয়েস্ট কেন ভালো রিভিউ পায়।
- একটা সহজ ব্রাঞ্চিং ওয়ার্কফ্লো: ফিচার ব্রাঞ্চ, পুল রিকোয়েস্ট, আর এমন একটা main ব্রাঞ্চ যা সবসময় রিলিজযোগ্য থাকে।
- কমিট মেসেজ, একটা ডেফিনিশন অফ ডান আর ইস্যু ট্র্যাকার কীভাবে কাজগুলোকে জুড়ে রাখে।
- পেয়ার প্রোগ্রামিং কী, আর কখন এটা লাভজনক।
কেন কোড রিভিউ
কোড রিভিউ (code review) হলো একটা পরিবর্তন ভাগ করা কোডে যোগ হওয়ার আগে, যিনি লেখেননি এমন অন্তত একজনের করা যাচাই। টিমগুলো এটা করে তিনটা মূল কারণে:
- আগেভাগে ডিফেক্ট খুঁজে পাওয়া। দ্বিতীয় একজন পাঠক বাদ পড়া যাচাই, ভুল সীমা, লেখক যে ক্ষেত্রের কথা ভাবেননি তা খেয়াল করেন। রিলিজের আগে ঠিক করা পরে ঠিক করার চেয়ে সস্তা; ISTQB-এর টেস্টিং সিলেবাস একই ভাবনাকে তার একটা নীতি হিসেবে রেখেছে, "Early testing saves time and money" (আগেভাগে টেস্টিং সময় আর অর্থ বাঁচায়), আর রিভিউ হলো সবচেয়ে আগের যাচাইগুলোর একটা।
- জ্ঞান ভাগ করা। আইকো ফারহানের রিমাইন্ডার কোড রিভিউ করার পর দুজন মানুষ সেটা বোঝেন। লঞ্চের সপ্তাহে ফারহান অসুস্থ হলেও কাজ থামে না।
- কোডকে সামঞ্জস্যপূর্ণ রাখা। রিভিউ নাম, গঠন আর এরর সামলানোকে ভাগ করা স্টাইলে রাখে, ফলে পুরো কোডবেস পড়তে লাগে একটা যত্নশীল টিমের কাজের মতো।
রিভিউ টেস্টের বিকল্প নয়, আর এটা এমন কোনো দরজাও নয় যেখানে একজন সিনিয়র জুনিয়রদের কাজ পাস বা ফেল করান। জুনিয়ররাও সিনিয়রদের কোড রিভিউ করেন; কোনো কোডবেস শেখার সবচেয়ে দ্রুত উপায়গুলোর একটা এটা।
একজন রিভিউয়ার কী খোঁজেন
আগের পাতার ফরম্যাটার আর লিন্টার বিন্যাসের কাজ আগেই সেরে ফেলে, তাই মানুষের সময় যায় এমন বিষয়ে যা টুল বিচার করতে পারে না। একটা চেকলিস্ট রিভিউকে সামঞ্জস্যপূর্ণ রাখে:
| প্রশ্ন | ClinicQueue-এর উদাহরণ |
|---|---|
| ইস্যু আর তার অ্যাকসেপ্টেন্স ক্রাইটেরিয়া যা চায়, এটা তা-ই করে কি না? | ইস্যু বলে "ব্যর্থ SMS একবার আবার চেষ্টা করুন"; কোড তিনবার চেষ্টা করে। |
| প্রান্তের ক্ষেত্রগুলোতে এটা সঠিক কি না? | রোগীর ফোন না থাকলে, বা প্রথম চেষ্টা আর পুনরায় চেষ্টার মাঝখানে অ্যাপয়েন্টমেন্ট বাতিল হলে কী হয়? |
| টেস্ট আছে কি না, আর সেগুলো পাস করে কি না? | "ব্যর্থ, তারপর পাঠানো"-র জন্য একটা টেস্ট, আর "দুবার ব্যর্থ"-র জন্য একটা। |
| এটা পড়ার উপযোগী আর টিমের স্টাইলে লেখা কি না? | পরিষ্কার নাম, ম্যাজিক নম্বর নেই (MAX_SMS_RETRIES = 1), ছোট ফাংশন। |
| এটা ডিজাইনের সাথে খাপ খায় কি না? | পুনরায় চেষ্টার লজিক থাকবে রিমাইন্ডার মডিউলে, স্ক্রিনের কোডে নয়। |
| এটা নিরাপদ কি না? | লগে ফোন নম্বর বা মেসেজের টেক্সট লেখা হয় না; কোডে কোনো গোপন কি (secret key) নেই। |
| কিছু বাদ পড়েছে কি না? | নতুন sent_status মানের জন্য ডেটাবেসের পরিবর্তন; চেঞ্জ লগে একটা লাইন। |
রিভিউ কমেন্ট দেওয়া আর নেওয়া
রিভিউ হলো কোড নিয়ে সহকর্মীদের কথোপকথন, মানুষের বিচার নয়। একটা কমেন্ট কীভাবে লেখা হয়, তার ওপরই নির্ভর করে সেটা সাহায্য করবে কি না।
এমন কমেন্ট লেখা, যা সাহায্য করে
- মানুষ নয়, কোড নিয়ে বলুন: "আপনি সেভ করতে ভুলে গেছেন"-এর বদলে "এই ফাংশন সেভ করার আগেই return করে"।
- কেন, তা ব্যাখ্যা করুন, যাতে লেখক শুধু সমাধান নয়, নিয়মটাও শেখেন।
- নিশ্চিত না হলে প্রশ্ন করুন: হয়তো লেখক এমন কিছু জানেন যা আপনি জানেন না।
- কমেন্টটা কতটা জরুরি, তা চিহ্নিত করুন। অনেক টিম ছোট, ঐচ্ছিক বিষয়ের আগে "nit:" (nit-pick-এর সংক্ষেপ, মানে খুঁটিনাটি) লেখে, যাতে লেখক জানেন কোন কমেন্ট ঠিক করতেই হবে।
- ভালো কী, সেটাও বলুন। ছোট্ট একটা "বাতিল ক্ষেত্রের জন্য দারুণ টেস্ট" লেখককে জানায় কী করে যেতে হবে।
উদাহরণ:
Unhelpful: "This is wrong."
Unhelpful: "Why would you ever do it like this?"
Helpful: "If the appointment is cancelled after the first SMS fails, the retry still sends.
Could we check the status again before retrying? Patients may get a reminder
for a cancelled visit."
Helpful: "nit: `n` could be `retries_left`, easier to read. Not blocking."
Helpful: "Question: is one retry enough? The issue says once, so fine if that was agreed."কমেন্ট গ্রহণ করা
কোয়ামে যখন আপনার পরিবর্তনে কমেন্ট দেন, তিনি প্রোডাক্টকে সাহায্য করছেন, আপনাকে আক্রমণ করছেন না। সমস্যা খুঁজে দেওয়ার জন্য ধন্যবাদ দিন; কোনো রোগীর চেয়ে একজন সহকর্মী সেটা খুঁজে পেলে অনেক ভালো। একমত না হলে থ্রেডে আপনার কারণ ব্যাখ্যা করুন; দুবার ঘুরেও একমত না হলে আরও লেখার বদলে পাঁচ মিনিট কথা বলুন। প্রতিটা কমেন্টের উত্তর দিন, সমাধান দিয়ে বা কারণ দিয়ে, যাতে রিভিউয়ার জানেন কিছুই বাদ পড়েনি।
ছোট পুল রিকোয়েস্ট
পুল রিকোয়েস্ট (pull request, PR; কিছু টুল একে merge request বলে) হলো আপনার ব্রাঞ্চের কমিটগুলো main ব্রাঞ্চে মার্জ করার একটা অনুরোধ, সাথে রিভিউ কমেন্টের জায়গা। ছোট পুল রিকোয়েস্ট অনেক ভালো রিভিউ পায়। একশো লাইনের পরিবর্তন একজন রিভিউয়ার মাথায় রেখে প্রতিটা নিয়ে ভাবতে পারেন; দুই হাজার লাইনের সামনে বেশিরভাগ মানুষ চোখ বুলিয়ে অনুমোদন দিয়ে দেন। ছোট PR তাড়াতাড়ি মার্জ হয়, অন্যদের কাজের সাথে কম সংঘাত বাধায়, আর কিছু ভুল হলে ফিরিয়ে নেওয়াও সহজ।
ছোট রাখার উপায়: প্রতি PR-এ একটা ইস্যু; রিফ্যাক্টরিং আর আচরণের পরিবর্তন আলাদা (ঠিক আগের পাতার অভ্যাস); আর বড় একটা ফিচারকে এমন ধাপে ভাগ করা, যার প্রতিটা মার্জ করা নিরাপদ, যেমন "retry failed SMS"-এর আগে "sent_status কলাম যোগ করা"। ভালো একটা PR বিবরণ রিভিউয়ারের সময় বাঁচায়:
টেমপ্লেট:
Title: Retry a failed reminder SMS once (#57)
What: When the SMS provider reports a failure, the reminder is retried once after
10 minutes. Status goes pending -> failed -> sent, or stays failed.
Why: Issue #57: Rina sees patients who missed the reminder because of one failed send.
How to test:
1. Run the test suite (new tests: test_retry_once, test_no_retry_if_cancelled).
2. In the test environment, set the fake SMS provider to fail once and book a slot.
Not included:
Showing failed reminders on the front-desk screen (issue #58).ব্রাঞ্চ, পুল রিকোয়েস্ট আর রিলিজযোগ্য main
ব্রাঞ্চ (branch) হলো কমিটের একটা আলাদা ধারা, যাতে আর কাউকে বিরক্ত না করে আপনি একটা পরিবর্তনে কাজ করতে পারেন। ClinicQueue একটা সহজ, খুব প্রচলিত ওয়ার্কফ্লো ব্যবহার করে, যাকে প্রায়ই ফিচার-ব্রাঞ্চ ওয়ার্কফ্লো বলা হয়:
- main ব্রাঞ্চে সবসময় এমন কোড থাকে যা কাজ করে আর রিলিজ করা যায়। কেউ এতে সরাসরি কমিট করেন না।
- প্রতিটা ইস্যুর জন্য ডেভেলপার main থেকে স্বল্পায়ু একটা ফিচার ব্রাঞ্চ বানান, ইস্যুর নামে।
- তিনি ব্রাঞ্চে ছোট ছোট ধাপে কমিট করেন আর সেটা ভাগ করা রিপোজিটরিতে push করেন।
- তিনি একটা পুল রিকোয়েস্ট খোলেন। স্বয়ংক্রিয় যাচাই চলে (ফরম্যাটার, লিন্টার, টেস্ট), আর অন্তত একজন সহকর্মী রিভিউ করেন।
- যাচাই পাস করলে আর রিভিউ অনুমোদিত হলে ব্রাঞ্চটা main-এ মার্জ হয় আর মুছে ফেলা হয়।
উদাহরণ:
main o-----o----------------o-----------o------ always releasable
\ \ / /
57-sms-retry \ o----o-----o-' / PR #61, reviewed by Aiko
\ /
58-failed-list o-------o--------o---------' PR #62, reviewed by Kwame
o = a commit a line joining main = a reviewed pull request being mergedএই ধারার জন্য Git কমান্ড অল্প কয়েকটাই। এখানে শুধু মনে করিয়ে দেওয়ার জন্য দেখানো হলো; খুঁটিনাটি AI-এর জন্য Git, API ও ব্যাকএন্ড: বিগিনার-এর বিষয়।
উদাহরণ:
git switch main
git pull get the latest main
git switch -c 57-sms-retry new branch for issue 57
git add reminders.py test_reminders.py
git commit -m "Retry a failed reminder SMS once"
git push -u origin 57-sms-retry then open a pull request in the shared repository"main রিলিজযোগ্য থাকে" কেন জরুরি
main সবসময় কাজ করলে নাদিয়ার যখনই কোনো সংশোধন দরকার টিম রিলিজ করতে পারে, নতুন ডেভেলপার main থেকে শুরু করে তাতে ভরসা রাখতে পারেন, আর কিছু ভাঙলে কারণটা থাকে সর্বশেষ মার্জ হওয়া পুল রিকোয়েস্টে। এর মূল্য হলো শৃঙ্খলা: অসমাপ্ত কাজ ব্রাঞ্চেই থাকে (বা এমন একটা সুইচের পেছনে, যা সেটা লুকিয়ে রাখে), আর ভাঙা main অন্য সবকিছুর আগে ঠিক করা হয়।
ব্রাঞ্চ কতদিন বাঁচবে?
এখানে টিমভেদে পার্থক্য আছে। কেউ কেউ ফিচার ব্রাঞ্চ এক সপ্তাহ বা তারও বেশি রাখে আর প্রতিটা যত্ন করে রিভিউ করে। অন্যরা দিনে কয়েকবার খুব ছোট পরিবর্তন main-এ মার্জ করে, পেয়ারিং, দ্রুত রিভিউ আর শক্তিশালী স্বয়ংক্রিয় টেস্টের ওপর ভরসা করে। দীর্ঘজীবী ব্রাঞ্চ main থেকে দূরে সরে যায়, আর সেগুলো মার্জ করা কষ্টকর হয়ে ওঠে। ClinicQueue-এর মতো নতুন টিমের জন্য ভালো ডিফল্ট হলো প্রতি ইস্যুতে একটা ব্রাঞ্চ, এক-দুই দিনের মধ্যে মার্জ।
কমিট, ডান আর ইস্যু
কমিট মেসেজ
কমিটের ইতিহাস হলো প্রজেক্টের স্মৃতি। কয়েক মাস পরে প্রায়ই কমিট মেসেজই একমাত্র জায়গা, যেখানে লেখা থাকে একটা লাইন কেন বদলেছিল। কাজের একটা মেসেজে থাকে আদেশসূচক ভঙ্গিতে ("Retry …", "Fix …", "Add …") ছোট একটা সারাংশ লাইন, একটা ফাঁকা লাইন, আর দরকার হলে এমন একটা মূল অংশ, যা কেন ব্যাখ্যা করে আর ইস্যুর উল্লেখ করে। অনেক টিম সারাংশ লাইনটা মোটামুটি ৫০ অক্ষরের মধ্যে রাখে; এটা একটা প্রচলিত রীতি, Git-এর কোনো নিয়ম নয়।
উদাহরণ:
Weak: "fix" "changes" "wip" "final version 2"
Better: Retry a failed reminder SMS once
The SMS provider sometimes rejects a message for a short time.
One retry after 10 minutes covers most of these cases without
sending duplicates. Cancelled appointments are not retried.
Refs #57
Conventional Commits style (optional):
feat(reminders): retry a failed SMS once
fix(queue): sort patients by time, not by text
refactor(queue): split print_day into small functionsশেষ তিনটা লাইন ব্যবহার করেছে Conventional Commits, একটা জনপ্রিয় কনভেনশন, বাধ্যবাধকতা নয়; এর ফরম্যাট আর এটা কীভাবে কমিট মেসেজকে ভার্সন নম্বরের সাথে জোড়ে, তা সফটওয়্যার রিলিজ ও রক্ষণাবেক্ষণ পাতায় ব্যাখ্যা করা হয়েছে।
একটা ডেফিনিশন অফ ডান
"ডান" (done, শেষ) বিভিন্ন মানুষের কাছে বিভিন্ন জিনিস: "আমি কোড লিখেছি", "এটা মার্জ হয়েছে", "এটা প্রোডাকশনে আছে"। ডেফিনিশন অফ ডান (Definition of Done) হলো ছোট, ভাগ করা একটা চেকলিস্ট, যা কেউ কোনো আইটেমকে শেষ বলার আগে প্রতিটা আইটেমকে পূরণ করতে হয়। ২০২০ সালের স্ক্রাম গাইডে Definition of Done হলো ইনক্রিমেন্টের প্রতিশ্রুতি (commitment); যেসব টিম স্ক্রাম ব্যবহার করে না, তারাও এর থেকে সমান লাভবান হয়। ClinicQueue-এরটা হলো অ্যাজাইল, স্ক্রাম ও কানবান পাতার ছোট ডেফিনিশন অফ ডানের পূর্ণ রূপ:
টেমপ্লেট:
Definition of Done (ClinicQueue)
[ ] Acceptance criteria of the issue are met and checked by someone other than the author
[ ] Automated tests written for the new behaviour; all tests pass
[ ] Formatter and linter pass
[ ] Pull request reviewed and approved by at least one teammate
[ ] Merged into main; main still passes all checks
[ ] Deployed to the test server and checked there
[ ] Screens work on a small phone
[ ] User-facing change noted in the change log; README updated if setup changed
[ ] No personal data (phone numbers, names) in logs or test dataতালিকাটা ইচ্ছা করেই ছোট। ত্রিশটা আইটেমের তালিকা কেউ মানে না; নয়টার তালিকা, প্রতিবার যাচাই করা, মানা হয়। বারবার ঘটা কোনো সমস্যা চোখে পড়লে টিম রেট্রোস্পেকটিভে তালিকাটা পর্যালোচনা করে।
ইস্যু ট্র্যাকিং
একটা ইস্যু ট্র্যাকার (issue tracker) প্রতিটা কাজকে একটা ইস্যু (টিকিটও বলে) হিসেবে রাখে: একটা ইউজার স্টোরি, একটা বাগ বা একটা টাস্ক, প্রতিটার একটা নম্বর, বিবরণ, অ্যাকসেপ্টেন্স ক্রাইটেরিয়া, একজন দায়িত্বপ্রাপ্ত মানুষ আর একটা স্ট্যাটাস। এর মূল্য আসে জিনিসগুলোকে জুড়ে দেওয়া থেকে: ইস্যু নম্বর থাকে ব্রাঞ্চের নামে (57-sms-retry), কমিট মেসেজে (Refs #57) আর পুল রিকোয়েস্টে, তাই যে কেউ কোডের একটা লাইন থেকে তার কারণে ফিরে যেতে পারেন, আর একটা রিকোয়ারমেন্ট থেকে সামনে কোডে যেতে পারেন। এটাই রিকোয়ারমেন্ট অধ্যায়ের ট্রেসেবিলিটির (traceability) ধারণা, প্রায় কোনো বাড়তি খাটুনি ছাড়াই হালনাগাদ রাখা। ট্র্যাকারের বোর্ড সেই একই ধরনের বোর্ড, যা আপনি অ্যাজাইল, স্ক্রাম ও কানবান পাতায় দেখেছেন।
পেয়ার প্রোগ্রামিং
পেয়ার প্রোগ্রামিং-এ (pair programming) দুজন ডেভেলপার একটা কম্পিউটারে (বা একটা ভাগ করা স্ক্রিনে) একই পরিবর্তনে কাজ করেন। একজন, যাঁকে প্রায়ই ড্রাইভার বলা হয়, টাইপ করেন; অন্যজন, নেভিগেটর, প্রতিটা লাইন লেখার সময়ই রিভিউ করেন, সামনের কথা ভাবেন আর সমস্যা ধরেন; তাঁরা প্রায়ই ভূমিকা বদলান। রিভিউটা চলতে থাকে অবিরাম, তাই অনেক টিম জোড়ায় করা পরিবর্তনের জন্য হালকা একটা আলাদা রিভিউই যথেষ্ট মনে করে। পেয়ারিংয়ে একটা কাজে দুজনের সময় লাগে, তাই এটা সবচেয়ে বেশি লাভ দেয় কঠিন বা ঝুঁকিপূর্ণ কোডে (যে বুকিং নিয়ম ডাবল বুকিং ঠেকায়), নতুন কাউকে কোডবেস শেখাতে, আর জটিল বাগে। নিয়মিত পরিবর্তনের জন্য একা কাজ আর সাধারণ একটা রিভিউ সাধারণত যথেষ্ট। পেয়ারিং ক্লান্তিকর; সারাদিনের চেয়ে বিরতিসহ ছোট সেশন ভালো কাজ করে।
কাজের জায়গায় এটা কোথায় লাগে
- বেশিরভাগ সফটওয়্যার কোম্পানিতে পুল রিকোয়েস্ট আর অন্তত একটা অনুমোদন ছাড়া কোনো কোড main-এ পৌঁছায় না; চাকরির প্রথম কয়েক সপ্তাহেই আপনাকে অনেক রিভিউ করতে হবে।
- ওপেন-সোর্স প্রজেক্টও একইভাবে চলে: বাইরের মানুষ পুল রিকোয়েস্ট হিসেবে পরিবর্তন প্রস্তাব করেন আর মেইনটেইনাররা রিভিউ করেন, তাই সম্মানজনক, পরিষ্কার একটা PR-ই আপনার অবদান গৃহীত হওয়ার পথ।
- একা কাজ করা ফ্রিল্যান্সাররাও ব্রাঞ্চ ব্যবহার করেন আর PR বিবরণ লেখেন; পরদিন সকালে নিজের পরিবর্তন নিজেই রিভিউ করেন, আর ক্লায়েন্ট একটা পরিষ্কার ইতিহাস দেখতে পান।
- রিলিজ ম্যানেজাররা পরের ভার্সনে কী যাবে তা ঠিক করতে রিলিজযোগ্য main আর পরিষ্কার কমিট মেসেজের ওপর ভরসা করেন।
সাধারণ ভুল
- বিশাল পুল রিকোয়েস্ট। দুই হাজার লাইনের PR দ্রুত একটা "দেখতে ভালো" পায় আর বাগ লুকিয়ে রাখে। সমাধান: প্রতি PR-এ একটা ইস্যু, রিফ্যাক্টরিং আলাদা, বড় ফিচার নিরাপদ ধাপে ভাগ করা।
- রিভিউকে ক্ষমতার খেলা বানানো। কঠোর বা ব্যক্তিগত কমেন্ট মানুষকে কাজ লুকাতে আর প্রশ্ন এড়াতে শেখায়। সমাধান: কোড নিয়ে কমেন্ট দিন, কেন তা ব্যাখ্যা করুন, ঐচ্ছিক বিষয় চিহ্নিত করুন, আর ভালো কী তা-ও বলুন।
- সরাসরি main-এ কমিট করা। রিভিউ না হওয়া কোড আর আধা-শেষ ফিচার রিলিজযোগ্য ব্রাঞ্চে ঢুকে পড়ে। সমাধান: রিপোজিটরির সেটিংসে main সুরক্ষিত করুন, যাতে পরিবর্তন শুধু রিভিউ করা পুল রিকোয়েস্টের মাধ্যমে আসে।
- দীর্ঘজীবী ব্রাঞ্চ। তিন সপ্তাহ রাখা ব্রাঞ্চ main থেকে দূরে সরে যায়, আর তার মার্জ জিনিসপত্র ভেঙে দেয়। সমাধান: ছোট ইস্যু, এক-দুই দিনের মধ্যে মার্জ, ঘনঘন main থেকে pull।
- সংজ্ঞা ছাড়া "ডান"। টেস্ট বাকি থাকতেই আইটেমকে শেষ বলা হয়। সমাধান: ছোট একটা ডেফিনিশন অফ ডান, যা পুরো টিম প্রতিবার যাচাই করে।
নিজে চেষ্টা করুন
- সহজ: এই রিভিউ কমেন্টগুলো এমনভাবে আবার লিখুন, যাতে সেগুলো সম্মানজনক আর কাজের হয়: (ক) "এটা একটা জগাখিচুড়ি।" (খ) "ভুল, একটা কনস্ট্যান্ট ব্যবহার করুন।" (গ) "আদৌ এটা টেস্ট করেছেন তো?"
- মাঝারি: আইকোর একটা ব্রাঞ্চে ১,৮০০ লাইন বদলেছে: ফ্রন্ট-ডেস্ক স্ক্রিনে ব্যর্থ রিমাইন্ডারের নতুন তালিকা, কিউ মডিউলের প্রতিটা ভেরিয়েবলের নাম বদল, ডেটাবেসের একটা নতুন কলাম, আর পথে পাওয়া সাজানোর একটা বাগের সমাধান। এটাকে কীভাবে কয়েকটা পুল রিকোয়েস্টে ভাগ করবেন, সেগুলো কোন ক্রমে মার্জ হবে, তা প্রস্তাব করুন, আর প্রতিটার জন্য একটা কমিট সারাংশ লাইন লিখুন।
- কঠিন: নাদিয়া জানালেন, গত সপ্তাহে একজন রোগী বাতিল হওয়া অ্যাপয়েন্টমেন্টের রিমাইন্ডার পেয়েছেন। এই পাতার ওয়ার্কফ্লো ব্যবহার করে রিপোর্ট থেকে রিলিজ পর্যন্ত পথটা বর্ণনা করুন: ইস্যু, ব্রাঞ্চ, কমিট, পুল রিকোয়েস্ট (ছোট একটা বিবরণসহ), এখানে সবচেয়ে জরুরি রিভিউ চেকলিস্টের বিষয়গুলো, আর নাদিয়াকে ঠিক হয়েছে বলার আগে ডেফিনিশন অফ ডানের কোন আইটেমগুলো যাচাই করতে হবে।
উত্তর
- নমুনা উত্তর: (ক) "এই ফাংশন এক জায়গাতেই খোঁজে, ফরম্যাট করে আর প্রিন্ট করে, তাই অনুসরণ করা কঠিন। এটাকে ছোট ছোট ফাংশনে ভাগ করা যায়, যেমন
print_day-এর বেলায় করেছিলাম?" (খ) "এখানকার 15 হলো স্লটের দৈর্ঘ্য; এখানেMINUTES_PER_PATIENTব্যবহার করা যায়, যাতে এক জায়গাতেই বদলায়?" (গ) "ফোন নম্বর খালি থাকলে কী হয়? ওই ক্ষেত্রের কোনো টেস্ট খুঁজে পেলাম না; একটা যোগ করবেন?" ভালো উত্তরে নির্দিষ্ট সমস্যার নাম থাকে, কেন জরুরি তা ব্যাখ্যা থাকে, একটা দিক দেখানো হয় বা সত্যিকারের প্রশ্ন করা হয়, আর মানুষটাকে বিচার করা হয় না। - একটা যুক্তিসঙ্গত ভাগ: PR ১ "refactor(queue): rename variables in the queue module" (আচরণে কোনো পরিবর্তন নেই, দ্রুত রিভিউ করা সহজ); PR ২ "fix(queue): sort patients by time, not by text" (টেস্টসহ ছোট একটা আচরণগত পরিবর্তন, নিজেই কাজের আর সঙ্গে সঙ্গে রিলিজযোগ্য); PR ৩ "feat(reminders): add a column for failed reminders" (ডেটাবেসের পরিবর্তন); PR ৪ "feat(queue): show failed reminders on the front-desk screen" (PR ৩-এর ওপর নির্ভরশীল)। ক্রম: নাম বদল আগে, যাতে পরের PR-গুলো পরিষ্কার কোডের ওপর দাঁড়ায়, অথবা ক্লিনিকের জন্য জরুরি হলে বাগ সমাধান আগে; PR ৩ অবশ্যই PR ৪-এর আগে। ভালো উত্তরে রিফ্যাক্টরিং আচরণের পরিবর্তন থেকে আলাদা থাকে, বাগ সমাধান নিজের PR-এ থাকে, ডেটাবেসের পরিবর্তন তা ব্যবহার করা স্ক্রিনের আগে আসে, আর প্রতিটা PR-এর একটা পরিষ্কার উদ্দেশ্য থাকে। Conventional Commits উপসর্গ ছাড়া সাধারণ সারাংশ লাইনও ঠিক আছে।
- নমুনা উত্তর: কোয়ামে বাগ ইস্যু #64 "Reminder sent for cancelled appointment" খোলেন, সাথে পুনরুৎপাদনের ধাপ, প্রত্যাশিত আর প্রকৃত ফল। ফারহান main হালনাগাদ করে
64-no-reminder-after-cancelব্রাঞ্চ বানান। তিনি আগে এমন একটা টেস্ট লেখেন, যা বুক করে, বাতিল করে আর রিমাইন্ডার জব চালায়, আর দেখেন সেটা ব্যর্থ হয়; তারপর রিমাইন্ডার জব ঠিক করেন, যাতে পাঠানোর ঠিক আগে স্ট্যাটাস যাচাই হয়। কমিট: "Add test: no reminder for a cancelled appointment" আর "Check appointment status before sending a reminder (Refs #64)"। PR বিবরণে থাকে কী বদলেছে, কেন (#64), কীভাবে টেস্ট করবেন, আর কী অন্তর্ভুক্ত নয়। সবচেয়ে জরুরি রিভিউ বিষয়: প্রান্তের ক্ষেত্রে সঠিকতা (রিমাইন্ডার পরিকল্পিত হওয়ার পরে বাতিল; বাতিল করে আবার বুক; বাতিলের পরে পুনরায় চেষ্টা), ওই ক্ষেত্রগুলোর টেস্ট, আর লগে রোগীর কোনো ডেটা নেই। ডেফিনিশন অফ ডান: অ্যাকসেপ্টেন্স ক্রাইটেরিয়ন ফারহান ছাড়া অন্য কেউ (কোয়ামে) যাচাই করেছেন, সব টেস্ট আর যাচাই পাস করেছে, রিভিউ হয়ে মার্জ হয়েছে, main এখনো সব যাচাই পাস করে, টেস্ট সার্ভারে ডিপ্লয় করে সেখানে যাচাই করা হয়েছে, চেঞ্জ লগে লাইন "Fixed: reminders were sent for cancelled appointments"। কেবল তখনই সমাধানটা রিলিজ হয় আর নাদিয়াকে রিলিজের তারিখসহ জানানো হয়। ভালো উত্তরে এমন একটা টেস্ট থাকে যা সমাধানের আগে ব্যর্থ হয়, সবকিছু ইস্যু নম্বরের সাথে জোড়া থাকে, আর "কোড লেখা হয়েছে" পর্যায়ে একে শেষ বলা হয় না।
সারসংক্ষেপ
- কোড রিভিউ আগেভাগে ডিফেক্ট (defect) খোঁজে, জ্ঞান ছড়ায় আর কোডকে সামঞ্জস্যপূর্ণ রাখে; একটা চেকলিস্ট একে সঠিকতা, টেস্ট, পড়ার উপযোগিতা, ডিজাইন, নিরাপত্তা আর বাদ পড়া অংশের দিকে মনোযোগী রাখে।
- ভালো রিভিউ কমেন্ট কোড নিয়ে হয়, কেন তা ব্যাখ্যা করে, কোনটা ঐচ্ছিক তা চিহ্নিত করে, আর ভালো কী তা-ও বলে; লেখক প্রতিটা কমেন্টের উত্তর দেন।
- পরিষ্কার বিবরণসহ ছোট পুল রিকোয়েস্ট সত্যিকারের রিভিউ পায়; রিফ্যাক্টরিংকে আচরণের পরিবর্তন থেকে আলাদা রাখুন।
- ফিচার-ব্রাঞ্চ ওয়ার্কফ্লোতে প্রতিটা পরিবর্তন স্বল্পায়ু একটা ব্রাঞ্চ থেকে রিভিউ করা পুল রিকোয়েস্ট হয়ে এমন একটা main ব্রাঞ্চে যায়, যা রিলিজযোগ্য থাকে।
- পরিষ্কার কমিট মেসেজ, ছোট একটা ডেফিনিশন অফ ডান আর ইস্যু ট্র্যাকার প্রতিটা পরিবর্তনকে তার কারণের সাথে জুড়ে রাখে; পেয়ার প্রোগ্রামিং হলো অবিরাম রিভিউ, কঠিন বা ঝুঁকিপূর্ণ কাজের জন্য সবচেয়ে ভালো।
এরপর: সফটওয়্যারের মান, টেস্টিং ও QA: কী টেস্ট করবেন তা কীভাবে ঠিক করবেন, ClinicQueue-এর জন্য টেস্ট কেস কীভাবে সাজাবেন, আর বাগ এমনভাবে রিপোর্ট করবেন যাতে সেগুলো ঠিক হয়।

