প্রতিশ্রুতিবদ্ধ বার্তা কি বর্তমান বা অতীত কাল লেখা উচিত? [বন্ধ]


102

সুতরাং এটি কোনটি আপনি ভাল এবং আরও স্বজ্ঞাত বলে মনে করেন?

Fixed the XXX bug in YYY
Fix the XXX bug in YYY
Fixes the XXX bug in YYY
Fixing the XXX bug in YYY

দয়া করে আপনার যুক্তি সরবরাহ করুন। দ্রষ্টব্য আমি আপনার সাধারণ দৃষ্টিকোণ থেকে জিজ্ঞাসা করছি, এর অর্থ আপনার এটিকে আপনার পছন্দের এসএনএন / সিভিএস সরঞ্জামগুলি বা প্রোগ্রামিং ভাষার সাথে সংযুক্ত করার চেষ্টা করা উচিত নয়, বরং এটি এমন কোনও বিষয় হিসাবে ভাবুন যা কোনও সরঞ্জাম এবং প্রোগ্রামিং ভাষায় প্রয়োগ করা উচিত।


আপনার কাজের কেউ খুব প্যাডেন্টিক, আমি আশা করি এটি আপনি নন। যারাই এটি বর্তমানের নিখুঁত বনাম, বর্তমান অসম্পূর্ণ, এবং কমিট কমেন্টটি যেমন টাইপ করা হয়েছে, বা এটি নিজেই ভান্ডারটিতে স্থির ছিল সে সময় থেকে পড়া হয় কিনা তার দার্শনিক দিক বিবেচনা করা উচিত। যদি দ্বিতীয়টি হয় তবে উপস্থিত একটি সম্পূর্ণ ক্রিয়াটির জন্য নিখুঁতভাবে ব্যবহার করুন। যদি পূর্বের হয় তবে একটি অসম্পূর্ণ উপস্থিত ক্রিয়াকলাপের জন্য অপূর্ণ ব্যবহার করুন।
হানিকানট

1
এই প্রশ্নের একটি দ্বিধা নয়। এটি সামগ্রিক নির্দেশিকা নয়, একটি ছোট দিক সম্পর্কে জিজ্ঞাসা করছে।

3
ভাগ্যক্রমে, এটি হয় না। আমি জিজ্ঞাসা করছিলাম, এটি চেষ্টা করার চেষ্টা করছিলাম, সেখানে সাধারণ অনুশীলনটি কী তা জানতে চাই। আমাকে যদি সত্য বলতে হয়, এটি আসলে সবচেয়ে তাত্পর্যপূর্ণ প্রশ্ন যা আমি এসও-তে জিজ্ঞাসা করেছি, কিন্তু ওহে, এটি এখনও একটি প্রশ্ন, তাই না? প্রশ্নটি নিজেই তিনটি ভোট পেয়েছে, যা (যদি আপনার কাছে না দেখানো হয়) তা বলে যে আমি কেবল সেখানেই নন যিনি ভাবেন যে এই প্রশ্নটি নিজের মধ্যে বৈধ। আমি গঠনমূলক উত্তরের পরে আছি এবং আপনি মোটেই সহায়ক হচ্ছেন না।
তার

1
যদি আপনি ভেবেছিলেন যে প্রতিশ্রুতিবদ্ধ বার্তাগুলিতে টেনেস সম্পর্কে লোকেরা খুব বেশি চিন্তা না করে তবে ভাল করে বলুন, আপনার কারণ এবং আপনার পছন্দগুলি উল্লেখ করুন। আপনার উপরের ব্যঙ্গাত্মক মন্তব্যের চেয়ে অনেক বেশি দরকারী এবং সহায়ক।
তাঁর

10
আমি এই প্রশ্নটি খুব গুরুত্ব সহকারে নিই। এটি একটি দুর্দান্ত প্রশ্ন। সফ্টওয়্যার বিকাশকালে সামঞ্জস্যপূর্ণ হওয়া খুব গুরুত্বপূর্ণ, এবং এই ওয়েবসাইটের বিষয়টিতে আগ্রহী সমস্ত দর্শনার্থীর পক্ষে এটি হওয়া উচিত। এটা আমার মতামত।
নিক্লাস বার্গ্লুন্ড

উত্তর:


39

এই বার্তাগুলি অন্য বিকাশকারীদের কাছে উপস্থিত হওয়ার সাথে সাথে আমি তাদের সম্পর্কে ভাবছি। তাদের এখনও পরিবর্তনগুলি প্রয়োগ করা হয়নি, এবং অন্তর্নিহিত প্রশ্ন রয়েছে, "এই পরিবর্তনটি / প্যাচটি কী করবে?" এটি "YYY এ XXX বাগটি ঠিক করবে"!

কমান্ড হিসাবে এগুলি লিখতে অন্য ক্রিয়াগুলির জন্য আরও প্রাকৃতিক বলে মনে হয় এবং আপ-ফ্রন্টের নির্দিষ্ট লক্ষ্য থাকলে আপনি আরও ভাল কাজ করেন the কাজটি শেষ হওয়ার আগে আপনি আক্ষরিক অর্থে আপ-ফ্রন্ট পরীক্ষার সাথে কমিটের সংক্ষিপ্তসারটি লিখতে পারেন।

আমি এতে প্রচুর পরিমাণে ওজন রাখি না, তবে ধারাবাহিকতা বজায় রেখে আমার পক্ষে এটি সর্বনিম্ন প্রতিরোধের পথ।


8
আমি মনে করি গিট ডকুমেন্টেশনের কিছু অংশ জুড়ে আসার বিষয়টি দৃ strongly়তার সাথে সুপারিশ করছে, তবে আমি এখনও বিশ্রী অবস্থায় খুঁজে পাই।
কিথজগ্রান্ট

1
এটি গিট ডকুমেন্টেশনের অংশটি এসেছে।
স্কুবার্থ

31

আমি ব্যক্তিগতভাবে অতীত কাল ("স্থির") সাথে চলেছি যেহেতু আমি বাগটি সংশোধন করার সময়টি ঠিক হয়ে গেছে (বা আমি প্রতিশ্রুতি দিচ্ছি না)।


আপনি একটি উদাহরণ দিতে পারেন?
bzlm

15
এর একটি উদাহরণ
শ্রদ্ধেয় গনজো

একে বলা হয় 'কমিট ইতিহাস'। ইতিহাস সর্বদা অতীত কাল লেখা হয়। অতীত কাল আরও বোধগম্য। আপনি যখন কিছু রেপো এর প্রতিশ্রুতিবদ্ধ ইতিহাসের মধ্য দিয়ে যাচ্ছেন তখন আপনি এটি কী হয়েছে তা দেখছেন ... অতীতে!
শিব

13

আমি বর্তমান সময়ে প্রতিশ্রুতিবদ্ধ বার্তাগুলি দেখতে পছন্দ করি। এইভাবে বার্তাটি কীভাবে আলাদা করে তা বর্ণনা করে (কারণ আপনি সেই ভিন্নতাটিকে টানতে পারেন বা এমনকি সম্পূর্ণ কমিটকে একটি ভিন্ন শাখায় পরিণত করতে পারেন)। সুতরাং, প্রতিশ্রুতিবদ্ধ বার্তা এটি "কী" করেছিল তা বর্ণনা করে না ... এটি প্রতিশ্রুতিবদ্ধভাবে "কী" করে তা বর্ণনা করে। সুতরাং এটি বর্তমান কাল হতে হবে।

কল্পনা করুন যে বিচ্ছিন্নতার মধ্যে কোনও পার্থক্য রয়েছে এবং আপনি এটি প্রয়োগ করবেন কিনা তা সিদ্ধান্ত নেওয়ার চেষ্টা করছেন। অতীত কাল থেকে এটির কোনও শিরোনাম থাকা কোনও অর্থবোধ করে না।


1
"কি পরিবর্তন করে" কিন্তু একটি কমিট যা ছিল দ্বারা পরিবর্তন তৈরি করা হয় commited , এটি আগে থেকেই Git ইতিহাসে, তাই এটি ইতিমধ্যেই ছিল "প্রয়োগ"।
Iulian Onofrei

9

আইএমএইচওও যদি আপনি প্রসঙ্গটি বিবেচনা না করে এটি বর্ণনামূলক হতে চান তবে অবশ্যই "স্থির" অবশ্যই একমাত্র সঠিক বৈকল্পিক।

স্বজ্ঞাততা সম্পর্কে - যদি আমি কিছু চেঞ্জলগের দিকে লক্ষ্য করি তবে আমি অবশ্যই বুঝতে পারি যে আপনি বাগটি সংশোধন করেছেন বলে শব্দটির প্রসঙ্গে যে শব্দটি ব্যবহৃত হয়েছে তা আমি জানি তবে আমার মস্তিষ্ক এটি আরও দ্রুত এটি ধরবে যদি শব্দটি এই স্ব-লিখিত থাকে তবে নির্দিষ্ট উপায়।

"ফিক্সিং" সবচেয়ে খারাপ পছন্দ আইএমএইচও কারণ এটি কেবল প্যাচটি কী (যা জন্য) তা বর্ণনা করেই বোঝানো যায় না তবে এটি একটি বাগের স্থিতি হিসাবেও বোঝায় যার অর্থ এটিতে কাজ করা হচ্ছে এবং এখনও সমাধান হয়নি।


7
Fix the XXX bug in YYY
Teach the XXX to be more ZZZ
Correct typos in javadoc

সাধারণভাবে: {আবশ্যক ক্রিয়া b} প্রভাবিত বস্তু} {qualচ্ছিক যোগ্যতা}

যখন আমি কোনও প্যাচসেট বিবেচনা করি তখন প্রয়োজনীয় ফর্ম সমস্ত ব্যবহারের ক্ষেত্রে খাপ খায়।

  • আপনি এখানে কি করতে যাচ্ছেন?
  • এই প্যাচসেটটি কী করে?
  • কেন এই প্যাচসেট তৈরি করা হয়েছিল? (এক্সএক্সএক্স বাগ সংশোধন করার জন্য ...)
  • আমাকে ইয়াহে এক্সএক্সএক্স বাগটি ঠিক করতে হবে। অন্য শাখায় প্রতিশ্রুতি আছে যা ইতিমধ্যে এটি করে?

আপনার পছন্দ নির্বিশেষে, আমি ধারাবাহিকতা পঠনযোগ্যতা প্রচুর সাহায্য করে। একটি বাছুন এবং এটি দিয়ে লাঠি।


4
খুব ভাল কারণ। আমি সর্বদা এটি বিবেচনা করি যেন বার্তাটি "আমি একটি প্যাচ এবং আমি [বার্তা]" বলছে। আপনি সর্বদা একটি অপরিহার্য ক্রিয়া দিয়ে শুরু করুন।
ফ্লোরিসা

5

আমি মনে করি বর্তমান কালে বর্তমান প্রতিশ্রুতি সম্পর্কে লেখা একটি ভাল ধারণা, কারণ আপনি যখন অতীতকালীন পূর্ববর্তী অঙ্গীকারগুলি উল্লেখ করেন এটি আরও স্পষ্ট করে তোলে।


1
আমি রাজী. যদি প্রতিশ্রুতিবদ্ধতা নিজেকে উল্লেখ করে তবে এটিও সত্য, "এই প্রতিশ্রুতি F00F বাগ সংশোধন করে"।
bzlm

4

আমি মনে করি না এটি সত্যিই গুরুত্বপূর্ণ। উদ্দেশ্য হ'ল:

1) যা করা বা করা হচ্ছে তা জানান, যাতে বাগগুলি সহজেই পাওয়া যায়, সমস্যাগুলি আরও সহজতর করা যায় এবং সাধারণত প্রকল্পটি আরও সহজে বজায় রাখতে সক্ষম হয়।

২) কোন টিকিট স্থির ছিল তা জানাতে হবে, সুতরাং নিরীক্ষক (যদি তারা আপনার সংস্থায় ব্যবহৃত হয় তবে কোন টিকিটের সাথে সামঞ্জস্য রয়েছে তা পরিবর্তনগুলি দেখতে পারে)।

শেষ অবধি, যদি এটি 'ইতিমধ্যে স্থির হয়ে গেছে, "ফিক্সিং" এর কোনও অর্থ হয় না এবং আপনি যদি এখনও এটিতে কাজ করে থাকেন তবে "স্থির" সঠিক নয়।


1
অবশ্যই, কঠোরভাবে বলতে গেলে, এটি সত্য যে এটি কোনও বিষয় নয়। তবে যদি আপনাকে একটি বাছাই করতে হয়, আপনি যখন আপনার স্থানীয় গাছে একটি বাগ ঠিক করে ফেলেছেন এবং পরিবর্তনগুলি প্রতিশ্রুতিবদ্ধ করতে চান, আপনি কি "ফিক্সড এক্সএক্সএক্সএক্স" বা "ফিক্স এক্সএক্সএক্সএক্স" বা "ফিক্স এক্সএক্সএক্সএক্স" বলছেন?
তার

1
আমি মনে করি পাঠ্যটি খুব সংক্ষিপ্ত হলে এটি গুরুত্বপূর্ণ। মাঝে মাঝে আমি প্রতিশ্রুতিবদ্ধ বার্তাগুলি দেখি যা আমাকে বিস্মিত করে তোলে যে ১. একটি বাগ পাওয়া গেছে বা আসলে স্থির হয়েছে, বা ২. কোনও স্থির সিদ্ধান্ত নেওয়া হয়েছে কিনা বা আসলে প্রয়োগ করা হয়েছিল কিনা, বা ৩. জটিল ভ্রান্ত আচরণ আংশিক বা বাস্তবে সম্পূর্ণ স্থির ছিল কিনা। এবং কখনও কখনও বেশ কয়েকটি কমিট একই বাগের সাথে সম্পর্কিত। "এটি কমিট ড্রউবল () এর বাউন্সি সমস্যাটি সমাধান করে এবং টিকিট 66 666 বন্ধ করে দেয়" উত্তেজনাপূর্ণ কিছু যায় আসে না, কারণ পাঠ্যটি ভার্জোজ। তবে "ড্রবাল () ভুল বাউন্স করেছে", কমিট কী করেছে?
bzlm

2

" ফিক্স বাগ এক্স " " ফিক্সড বাগ এক্স " এর চেয়ে 2 টি অক্ষর ছোট ।
এবং " ফিক্সিং বাগ এক্স " এর চেয়ে 3 টি খাটো ।

সংক্ষিপ্ত-প্রতিশ্রুতি-বার্তা লেখার দৃষ্টিকোণ থেকে, বর্তমান কালটি মাঝে মাঝে / সাধারণত কয়েকটি চরিত্র সংরক্ষণ করে?
যা আমি আসলে কিছুটা গুরুত্বপূর্ণ বলে মনে করি যেমন গিটের প্রথম-প্রতিশ্রুতি-বার্তা লাইন -50-এর চেয়ে কম-চর-এর সুপারিশ সহ।
এছাড়াও, কম পাঠ্য -> দ্রুত পড়া শেষ হয়েছে?


1

একটি প্রতিশ্রুতিবদ্ধ বার্তা বর্ণনা করে যে আপনি কেন কোডটি লিখেছেন যা প্রতিশ্রুতিবদ্ধ হচ্ছে।

"স্থির ইস্যু 3124", বা "ফিক্সগুলি ইস্যু 3124" সঠিক বলে মনে হচ্ছে কারণ এটি এই কোডটি স্থির করে বলেছে fix ফিক্সগুলি 3124 ইস্যু করে।

তবে, ব্যাকটি ঠিক হিসাবে চিহ্নিত করা হয়েছে কেন তার উপরও ব্যাকরণ নির্ভর করতে পারে। যদি আপনি প্রতিশ্রুতি দেওয়ার পরে বাগটিকে ঠিক হিসাবে চিহ্নিত করতে পারেন তবে "ফিক্সড" ঠিক আছে তবে আপনার কোডটি যাচাই করার পরে যদি বাগটি অন্য কারও দ্বারা স্থির হিসাবে চিহ্নিত করা হয়, তবে "ফিক্সগুলি" আরও উপযুক্ত হতে পারে।


0

আমি মনে করি এই জাতীয় প্রশ্নের সবচেয়ে গুরুত্বপূর্ণ উত্তর হ'ল: প্রত্যেকেরই নির্দিষ্ট প্রকল্পের জন্য যা কাজ করে তা ব্যবহার করা উচিত এবং এটিকে কমপক্ষে একটি সামান্য বিট সামঞ্জস্য রাখতে হবে।

যদিও আমি বর্তমান কালটি ব্যবহার করার সুবিধাগুলি দেখছি (এবং প্রকৃতপক্ষে এই পোস্টটি হুমড়ি খেয়েছে কারণ আমি ওপেন সোর্স প্রকল্পগুলিতে কিছু বর্তমান কালীন বার্তা দেখেছি) তবে আমি সম্ভবত আমার প্রকল্পগুলির জন্য বর্তমান কালকে ব্যবহার করব না। এটি লিনাক্স এবং গিট এবং সম্ভবত অন্যান্য বড় ওপেন সোর্স প্রকল্পগুলির জন্য প্রস্তাবিত উপায়, তবে আমি যতক্ষণ না এই প্রকল্পগুলির অংশ না আছি ততক্ষণ সত্যই আমি যত্ন করি না।

আমি একটি ইন্ডি দেব এবং আমি প্রকাশিত নোটগুলির জন্য প্রতিশ্রুতিবদ্ধ বার্তার প্রথম লাইনটি ব্যবহার করি যখন নীচের লাইনে বর্ণিত বিবরণটি আমাকে বাস্তবায়নের বিশদ সম্পর্কে ধারণা দেয়। বর্তমান কাল, বিকাশকারী ভিত্তিক পদ্ধতির তুলনায় এটি একটি ব্যবহারকারীকেন্দ্রিক কর্মপ্রবাহ। আমি এভাবে কিছু সময় বাঁচাতে পারি। আমার ব্যবহারকারীদের রিলিজ নোটগুলিতে নির্দেশনা দেওয়া অত্যন্ত অপ্রাকৃত হবে। বাগ ঠিক করা এবং বৈশিষ্ট্য যুক্ত করা আমার কাজ। আমাকে সময় বাঁচাতে হবে, কারণ আমি একটি ইনডি। আমার দলে আমার কোনও "রিলিজ নোটস লেখক" নেই।

যদি কোনও প্রকল্পের নিয়মগুলি ইতিমধ্যে প্রতিষ্ঠিত হয় তবে সেগুলি ব্যবহার করুন তবে ব্যবহারিক থাকুন এবং আপনার কাজটি সহজ বা দ্রুততর করে তোলে তা যা কিছু করুন।


-1

আমি মনে করি বর্তমান কালকে ব্যবহার করার কারণটি যদি প্রতিশ্রুতিবদ্ধ ব্যক্তিটি না করে বরং " কমিটটি কী করে তার আরও বর্ণনামূলক করে তোলা" এর"Fixes XXX bug" চেয়ে বেশি বোধগম্য হয় ।"Fix XXX bug"


-4

যদি এটি একটি ছোট প্রতিশ্রুতি থাকে তবে আমি উপস্থিত অবিরত ব্যবহার করি:

ফিক্সিং বাগ 304

অথবা

মন্তব্য যুক্ত করা হচ্ছে

যদি এটি বড় প্রতিশ্রুতিবদ্ধ হয় তবে আমি পরিবর্তনের লগটি আরও করি:

  • সংশোধন বাগ 453, 657 এবং 324
  • এক্সপ্রেশন সিনট্যাক্স যুক্ত করা হচ্ছে
  • অপারেটর ক্লাস রিফ্যাক্টর।

9
অন্য কথায় আপনি
এগুলির

যথেষ্ট. কারণ শেষ পর্যন্ত, প্রতিশ্রুতিবদ্ধ বার্তাগুলির রানী ইংরেজী হওয়ার দরকার নেই।
ttor

2
যাইহোক আপনার প্রতিশ্রুতিবদ্ধতায় বিভিন্ন রকমের কাজ করা উচিত নয়।
ফ্লোরিসালা
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.