এই নথিটি Bazel অবদানকারীদের লক্ষ্য করা হয়েছে৷
Bazel-এ কমিট বিবরণ একটি RELNOTES: ট্যাগ এর পরে একটি রিলিজ নোট অন্তর্ভুক্ত করে। এটি Bazel টিম দ্বারা প্রতিটি প্রকাশের পরিবর্তনগুলি ট্র্যাক করতে এবং প্রকাশের ঘোষণা লিখতে ব্যবহৃত হয়।
ওভারভিউ
আপনার পরিবর্তন একটি বাগফিক্স? সেক্ষেত্রে আপনার রিলিজ নোটের প্রয়োজন নেই। GitHub সমস্যাটির একটি রেফারেন্স অন্তর্ভুক্ত করুন।
যদি পরিবর্তনটি ব্যবহারকারী-দৃশ্যমান উপায়ে Bazel যোগ / অপসারণ / পরিবর্তন করে, তাহলে এটি উল্লেখ করা সুবিধাজনক হতে পারে।
পরিবর্তন যদি তাৎপর্যপূর্ণ হয়, তাহলে প্রথমে নকশা নথি নীতি অনুসরণ করুন।
নির্দেশিকা
রিলিজ নোটগুলি আমাদের ব্যবহারকারীরা পড়বেন, তাই এটি সংক্ষিপ্ত হওয়া উচিত (আদর্শভাবে একটি বাক্য), জার্গন (বাজেল-অভ্যন্তরীণ পরিভাষা) এড়িয়ে চলুন, পরিবর্তনটি কী তা নিয়ে ফোকাস করা উচিত।
প্রাসঙ্গিক ডকুমেন্টেশনের একটি লিঙ্ক অন্তর্ভুক্ত করুন। প্রায় যেকোনো রিলিজ নোটে একটি লিঙ্ক থাকা উচিত। যদি বিবরণে একটি পতাকা, একটি বৈশিষ্ট্য, একটি কমান্ডের নাম উল্লেখ থাকে, ব্যবহারকারীরা সম্ভবত এটি সম্পর্কে আরও জানতে চাইবেন।
কোড, চিহ্ন, পতাকা বা আন্ডারস্কোর সম্বলিত যেকোনো শব্দের চারপাশে ব্যাককোট ব্যবহার করুন।
শুধু বাগ বিবরণ কপি এবং পেস্ট করবেন না. এগুলি প্রায়শই গোপনীয় এবং শুধুমাত্র আমাদের কাছে উপলব্ধি করে এবং ব্যবহারকারীকে তাদের মাথা ঘামাচ্ছে। রিলিজ নোটগুলি ব্যবহারকারীর বোধগম্য ভাষায় কী পরিবর্তন হয়েছে এবং কেন তা ব্যাখ্যা করার জন্য বোঝানো হয়েছে৷
সর্বদা বর্তমান কাল এবং "ব্যাজেল এখন Y সমর্থন করে" বা "এক্স এখন Z করে" বিন্যাস ব্যবহার করুন। আমরা চাই না যে আমাদের রিলিজ নোটগুলো বাগ এন্ট্রির মতো শোনা যাক। সমস্ত রিলিজ নোট এন্ট্রি তথ্যপূর্ণ হওয়া উচিত এবং একটি সামঞ্জস্যপূর্ণ শৈলী এবং ভাষা ব্যবহার করা উচিত।
যদি কিছু অবচয় বা অপসারণ করা হয়, তাহলে "X কে অবমূল্যায়ন করা হয়েছে" বা "X সরানো হয়েছে" ব্যবহার করুন। "সরানো হয়েছে" বা "সরানো হয়েছে" নয়।
যদি Bazel এখন ভিন্নভাবে কিছু করে, বর্তমান সময়ে "X now $newBehavior এর পরিবর্তে $oldBehavior" ব্যবহার করুন। এটি ব্যবহারকারীকে বিস্তারিতভাবে জানতে দেয় যখন তারা নতুন রিলিজ ব্যবহার করবে তখন কী আশা করতে হবে।
যদি Bazel এখন সমর্থন করে বা কোনো কিছুকে সমর্থন করে না, তাহলে "Bazel now supports/আর সমর্থন করে না X" ব্যবহার করুন।
ব্যাখ্যা করুন কেন কিছু অপসারণ/অবচন/পরিবর্তন করা হয়েছে। একটি বাক্যই যথেষ্ট কিন্তু আমরা চাই ব্যবহারকারীরা তাদের বিল্ডের উপর প্রভাব মূল্যায়ন করতে সক্ষম হোক।
ভবিষ্যতের কার্যকারিতা সম্পর্কে কোনো প্রতিশ্রুতি দেবেন না। "এই পতাকা সরানো হবে" বা "এটি পরিবর্তন করা হবে" এড়িয়ে চলুন। এটি অনিশ্চয়তার পরিচয় দেয়। ব্যবহারকারী প্রথম যে জিনিসটি অবাক করবে তা হল "কখন?" এবং আমরা চাই না তারা কোনো অজানা সময়ে তাদের বর্তমান বিল্ড ভেঙে যাওয়ার বিষয়ে উদ্বিগ্ন হোক।
প্রক্রিয়া
রিলিজ প্রক্রিয়ার অংশ হিসাবে, আমরা প্রতিটি RELNOTES ট্যাগ সংগ্রহ করি। আমরা একটি Google ডক -এ সবকিছু অনুলিপি করি যেখানে আমরা নোটগুলি পর্যালোচনা করি, সম্পাদনা করি এবং সংগঠিত করি।
রিলিজ ম্যানেজার bazel-dev মেইলিং-তালিকায় একটি ইমেল পাঠায়। Bazel অবদানকারীদের নথিতে অবদান রাখার জন্য আমন্ত্রণ জানানো হয়েছে এবং নিশ্চিত করুন যে তাদের পরিবর্তনগুলি ঘোষণায় সঠিকভাবে প্রতিফলিত হয়েছে।
পরে, ঘোষণাটি Bazel ব্লগে জমা দেওয়া হবে, Bazel -blog repository ব্যবহার করে।