আপনি কি কোম্পানিতে প্রয়োগ করার জন্য একটি ভাল কমিট বার্তা টেম্পলেট / নির্দেশিকাগুলির প্রস্তাব দিতে পারেন? [বন্ধ]


38

গিটে একটি ভাল কমিট টেম্পলেট সেট করা এবং প্রয়োগ করা সম্ভব।

আপনি কি সুপারিশ করতে পারেন (পছন্দসই যুক্তি দিয়ে) সংস্থায় প্রয়োগ করার জন্য একটি ভাল কমিট টেম্পলেট / নির্দেশিকা?

উত্তর:


42

আমি ব্যবহার করি

[Abc]: Message.

অ্যাড, মোড (ইফআই), রেফ (অভিনেতা), ফিক্স, রিম (ওভ) এবং রিয়া (ধৈর্য) এর সাথে লগফাইলে উত্তোলন করা সহজ।

উদাহরণ:

Add: New function to rule the world.  
Mod: Add women factor in Domination.ruleTheWorld().  
Ref: Extract empathy stuff to an abstract class.  
Fix: RUL-42 or #42 Starvation need to be initialised before Energy to avoid the nullpointer in People.  
Rem: freeSpeech is not used anymore.  
Rea: Removed old TODO and extra space in header.  

আমার যদি কোনও রেখার বেশি থাকে তবে আমি প্রথমে এগুলি সর্বাধিক গুরুত্বপূর্ণ অনুসারে বাছাই করি।


1
+1 এটির সাথে ডিল করার একটি দুর্দান্ত উপায় এবং আপনি সহজেই পরিবর্তনের জন্য গ্রেপ করতে পারেন।
সারদাথ্রিয়ন - মনিকা

12
EEK! আপনি স্বাধীন বক্তৃতা কেড়ে নিয়েছেন!
ক্যাফগিকে

1
আপনি দয়া করে Modএবং এর মধ্যে কিছু পার্থক্য ব্যাখ্যা করতে পারেন Ref? কখনও কখনও আমি কেবল ছোট ফিক্সগুলি করছি যা এক ধরণের রিফ্যাক্টরিং।
ইয়াগেল

2
@ আইগেল Modকিছু যুক্ত করার বা আচরণের পরিবর্তন সম্পর্কিত, Refএমন অভ্যন্তরীণ জিনিসগুলি পরিবর্তন করার বিষয়ে যা কোনও ফাংশনালিটি যোগ করে না, এপিআই যোগ করে ইত্যাদি উদাহরণ: আমার যদি কোনও add(Object)ফাংশন থাকে এবং আমি কোনও add(List<Object>)ফাংশন বাস্তবায়ন করি তবে আমি তার সাথে মন্তব্য করব Mod। পরে আমি অনুলিপি মুছে ফেলুন এবং সরাসরি ব্যবহার add(Object)মধ্যে add(List<Object>)তারপর আমি ব্যবহার করবে Ref
রঙ্গজেন

14

আমরা নিম্নলিখিত ব্যবহার:

[জিরায় টিকিটের আইডি]: [বার্তা: কী করা হয়েছিল] উদাহরণস্বরূপ - এবিসি -123: প্রতি অঞ্চল উপস্থাপনা কনফিগার করার ক্ষমতা যুক্ত করেছে।

এই ক্ষেত্রে যথাযথ সংহতকরণের সাথে আপনি আপনার ইস্যু ট্র্যাকারে পরিবর্তন / মুছে ফেলা / যুক্ত ফাইলগুলি পেতে সক্ষম হবেন। তবে, সচেতন থাকুন যে আপনার এবিসি -123: সম্পন্ন বা এবিসি -123: সম্ভব হলে ফিল্টারগুলি দিয়ে স্থির করা উচিত prevent


বাগ ফিক্সগুলির জন্য +1 তবে নতুন বৈশিষ্ট্যগুলির কী? JIRA তে নতুন বৈশিষ্ট্যগুলি না তৈরি করা না থাকলে ...
সারদাথ্রিয়ন - মনিকা পুনরায় ইনস্টল করুন

3
@ সারদাথ্রিয়ন - ব্যক্তিগতভাবে আমি জিরায় নতুন কার্যকারিতার জন্য ট্র্যাকার তৈরি করেছি create আমরা এটি বুগজিলার সাথে করি এবং এটি পরীক্ষার দলটিকে (এবং অন্য সবাইকে) একটি রিলিজের মধ্যে রাখা সমস্ত কিছুর ভাল দৃশ্যমানতা দেয় এবং যখন পরীক্ষা / কোড পর্যালোচনা / যা কিছু করা হয়নি তখন বাইরে বেরিয়ে আসা জিনিসগুলিকে হ্রাস করে।
জন হপকিনস

@ জনহপকিন্স: নতুন বৈশিষ্ট্যগুলির জন্য একটি বাগ ট্র্যাকার ব্যবহার করা যেতে পারে, এটি আদর্শ সরঞ্জাম নাও হতে পারে। অবশ্যই, আপনার মাইলেজটি পৃথক হবে ^ _ ~
সারদাথ্রিয়ন - মনিকা পুনরায় ইনস্টল করুন

3
আমি কাছে এসে প্রেম একটি টিকেট নির্ধারিত থাকার যে কমিট (কিছু টিকেট easly, একাধিক করে থাকতে পারে অবশ্যই): এটা যখন পরে কোড পরিদর্শন আরো পটভূমি তথ্য পেতে একটি খুব সহজ উপায়। "তারা কেন না যে?" আপনার কাছে কমিট করার মতামত এবং কোনও সমস্যা ট্র্যাকিং এন্ট্রি থাকলে উত্তর দেওয়া অনেক সহজ ।
জোচিম সৌর

আলাদা শাখায় টিকিট দেওয়া কি ভাল নয়?
ট্যামস সেজেলি

11

একটি সাধারণ নিয়ম রয়েছে, যা অনেকগুলি (সমস্ত না থাকলে) এসসিএম এবং এসসিএমগুলির সাথে কাজ করে এমন বেশিরভাগ সরঞ্জাম দ্বারা একটি কনভেনশন হয়:

প্রতিশ্রুতিবদ্ধ বার্তার প্রথম লাইন একটি সংক্ষিপ্তসার, অন্য বার্তায় বিশদ রয়েছে।

সুতরাং, বেশিরভাগ সরঞ্জাম কেবল প্রথম লাইনটি প্রদর্শন করে এবং পুরো বার্তাটি চাহিদা অনুযায়ী প্রদর্শন করে।

প্রতিশ্রুতিবদ্ধ বার্তার একটি সাধারণ অপব্যবহার হ'ল পরিবর্তনের বুলেট তালিকা (কেবলমাত্র প্রথম বুলেটটি প্রদর্শিত হবে)। আরেকটি অপব্যবহার হ'ল একটি লাইনে একটি দীর্ঘ বিবরণ বার্তা লিখছে।

সুতরাং, যদি প্রয়োগ করার জন্য কোনও জিনিস থাকে তবে আমি বলব এটি প্রথম লাইনের সর্বোচ্চ দৈর্ঘ্য।


আমি গিটে মোটেও দীর্ঘ বিশদ প্রতিশ্রুতি বার্তা লেখার কারণ দেখিনি। বিস্তারিত তথ্য ইস্যু ট্র্যাকারে যায় এবং তাই আমার প্রতিশ্রুতি বার্তাগুলি সেই প্রতিশ্রুতি অনুসারে আমি যে (ছোট) পরিবর্তন করেছি তার একটি মাত্র বাক্য বিবরণ।
মার্নেন লাইবো-কোসার

9

ব্যক্তিগতভাবে আমি ব্যবহার করার মতো কোনও সাধারণ কমিট টেম্পলেট কখনও দেখিনি। মন্তব্যে সংক্ষিপ্তভাবে বলা উচিত যে কমিটগুলি কী সম্পর্কিত যা উদাহরণস্বরূপ কোন বৈশিষ্ট্য / বাগ ফিক্স বা কেন পরিবর্তন করা হয়েছিল তার একটি সংক্ষিপ্ত বিবৃতি।

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

প্রতিশ্রুতি দেওয়ার পরে কোনও বাগ রিপোর্ট আপডেট করার সময় আমি বাগ রিপোর্টে থাকা মন্তব্যের পাশাপাশি কমিটের সংশোধনটিও বলা ভাল state এইভাবে আপনি বাগ রিপোর্টে প্রতিশ্রুতিবদ্ধ মন্তব্য থেকে আপনার পথ খুঁজে পেতে পারেন এবং বাগ প্রতিবেদনের প্রতিটি মন্তব্যের জন্য আপনি কী প্রতিশ্রুতিবদ্ধ তা সন্ধান করতে পারেন, তবে আপনি বাগ রিপোর্ট এবং প্রতিশ্রুতি বার্তা উভয়কেই রেখে নকল তথ্যটি বানাবেন না।

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


4
আপনি সঠিক ফর্ম্যাটে বিশদটি প্রবেশ করিয়ে দিলে অনেক বাগ সরঞ্জাম আপনাকে আপনার এসসিএম সরঞ্জামে পুনর্বিবেচনার সাথে সরাসরি লিঙ্ক করতে দেয়। একইভাবে, অনেকগুলি এসসিএম সরঞ্জাম আপনি সঠিক ফর্ম্যাটে বাগের বিশদটি প্রবেশ করিয়ে দিলে সরাসরি বাগ ডাটাবেসে সরাসরি লিঙ্ক করবে। আইএমও, যতক্ষণ আপনি এটি করেন ততক্ষণ আপনি সোনার।
ডিন হার্ডিং

4

গিটে গিট হুক দিয়ে প্রায় যে কোনও কিছু প্রয়োগ করা সম্ভব । ধারণাগুলির জন্য .git / হুকের উদাহরণগুলি দেখুন।

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

Extracted checking foobar range from bar() into foo(min, max) to re-use
in yadda() and blah(). foo() returns true if foobar is in the
specified range and false otherwise.

BugID: 123456
ReviewedBy: mabuddy
AutomergeTo: none

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


0

আমরা সমন্বিত একটি টেম্পলেট ব্যবহার করি

  • বাগ / বৈশিষ্ট্য / ফিক্সের আইডি নম্বর
  • একটি হ্যাঁ / না কোডটি পরীক্ষা করা হয়েছে কিনা তা বর্ণনা করে
  • এবং কমিটের উদ্দেশ্য সম্পর্কে একটি সংক্ষিপ্ত বিবরণের জন্য বিশদ বিভাগ

প্রথম দুটি বেশিরভাগ সময় বাদ দেওয়া হয় (মাঝে মাঝে তিনটিই) তাই এটি আসলে কোনও বড় বিষয় নয়।


0

আমি সাধারণত আমি ব্যবহার করি টিকিট ট্র্যাকিং সিস্টেমে সনাক্তকারী বা প্রথম লাইন হিসাবে একটি উচ্চ স্তরের ওভারভিউ রয়েছে। তারপরে আমার কাছে কমিটের নির্দিষ্ট পরিবর্তনের পংক্তি আইটেম "বুলেট" রয়েছে। সুতরাং আমি যেমন কিছু করতে পারে:

MyVideoGameProject-123 OR Inventory System Improvements
Made inventory GUI drap and drap
Added ability to have multiple bag slots to expand inventory capacity

এটি আমার কাছে সবচেয়ে ভাল কমিট ফর্ম্যাট। এটি প্রত্যক্ষ এবং বিন্দু। আমি অন্যভাবে এটি করার কারণটি হ'ল যদি আমি পরিবর্তন লগ তৈরি করতে চাই তবে আমি কেবল সমস্ত প্রতিশ্রুতি বার্তা নিতে পারি এবং এটি খুব সহজেই পরিবর্তনের লগে পার্স করতে পারি।


0

[টিকেটআইডি] [এবিসি] [বিষয় আইডি] [ডব্লিউআইপি] বার্তা, যেখানে:

  • টিকেট আইডি - টাস্ক সংগ্রহস্থলের আইটেমের আইডি
  • এবিসি - অ্যাড (ফিচার), ফিক্স (বাগফিক্স), স্টার (স্ট্রাকচার), ডিপ (নির্ভরতা) রিম (পেছনের অসঙ্গতি / অপসারণ), রি (রিডিবিলিটি), রেফ (রিফ্যাক্টরিং)
  • টপিকআইড - জেনকিন্স এবং / অথবা শাখার নাম এবং / বা জিরিতের জন্য টপিকের নামের জন্য চাকরী নির্বাচক হতে পারে
  • ডাব্লুআইপি - অগ্রগতিতে / বা না চলছে (যেমন ক্রমাগত সংহতকরণের এটির প্রয়োজন হতে পারে)
  • বার্তা - সংশোধন বিস্তারিত

উদাহরণস্বরূপ:
[# 452567] [যুক্ত করুন] [মেনু_ইটেম] নতুন আইটেম - গেস্টবুক
[# 452363] [ফিক্স] [ব্যানার_টপ] [ডব্লিউআইপি] 1024x300 এখন ব্যবহার করা যেতে পারে
[# 452363] [ফিক্স] [ব্যানার_টপ] 500x200 এখন ব্যবহার করা যেতে পারে
[ # 452713] [স্মৃতি] [পৃষ্ঠা] বাম মাঝের বিজ্ঞাপন


আপনার উত্তরটি আরও শক্তিশালী হবে যদি আপনি ব্যাখ্যা করেন যে আপনি কেন এটি এত ভাল ফর্ম্যাট feel যদিও এই ফর্ম্যাটটির মান আপনার কাছে স্বতঃস্ফূর্ত হতে পারে তবে এটির মান অন্যের কাছে তেমন সুস্পষ্ট নয়।

মন্তব্যের জন্য ধন্যবাদ - হ্যাঁ আমি শীঘ্রই আরও বিস্তারিতভাবে ব্যাখ্যা করব - আমি কেবল একটি সত্য দিয়ে শুরু করতে চেয়েছিলাম - এটি একটি ভাল স্ট্যাক বৈশিষ্ট্য যা আপনি ডাব্লুআইপি দিয়ে উত্তরটি স্বাক্ষর করতে পারেন :)
ল্যাপ্লাজ

'ওয়ার্ক ইন প্রগ্রেস' - এটি কি আপনার কাছে একটি নোট যা আপনি ফিরে আসবেন এবং সংশোধন করবেন, না আপনি এটিতে দক্ষতা অর্জনের প্রতিশ্রুতিবদ্ধ? যদি তাই হয় তবে কেন?
JBRWilkinson

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