قالب گزارش تغییرات

قالبی برای گزارش تغییرات پروژه نرم‌افزاری با پیروی از قراردادهای گزارش تغییرات.

# قالب تغییرات (Changelog): ابزاری ضروری برای مستندسازی حرفه‌ای پروژه نگهداری یک پروژه نرم‌افزاری چیزی فراتر از نوشتن کد است؛ این کار به معنای انتقال تحول کار شما به کاربران، مشارکت‌کنندگان و حتی خودِ آینده‌تان است. با این حال، برای بسیاری از توسعه‌دهندگان، وظیفه به‌روزرسانی فایل CHANGELOG.md اغلب به حاشیه رانده می‌شود یا در تب و تاب انتشار نسخه جدید کاملاً فراموش می‌شود. "Changelog Template" یک افزونه کروم است که برای پر کردن این شکاف طراحی شده و یک گردش کار ساده، بصری و حرفه‌ای برای نگهداری از لاگ‌های تغییرات با کیفیت بالا و مطابق با استانداردهای صنعت ارائه می‌دهد. ## هدف اصلی: ارتباط بهتر از طریق استانداردهای «Keep a Changelog» در هسته اصلی، افزونه Changelog Template ساخته شده است تا به پروژه‌های نرم‌افزاری کمک کند از قراردادهای «Keep a Changelog» پیروی کنند. یک لاگ تغییرات خوب، فهرستی دست‌چین شده و به ترتیب زمانی از تغییرات مهم برای هر نسخه از پروژه است. این یک لیست خام از کامیت‌های گیت نیست؛ سندی است که برای انسان نوشته شده است. با استفاده از این افزونه، اطمینان حاصل می‌کنید که تاریخچه پروژه شما خوانا، سازمان‌یافته و مفید است. چه در حال مدیریت یک پروژه جانبی کوچک باشید، چه یک کتابخانه متن‌باز بزرگ یا مجموعه‌ای از ابزارهای داخلی، Changelog Template ساختار مورد نیاز برای حفظ شفافیت و حرفه‌ای‌گری را بدون ایجاد اصطکاک در چرخه توسعه شما فراهم می‌کند. ## فرمت استانداردی که می‌توانید به آن اعتماد کنید این افزونه دقیقاً با فرمت استاندارد لاگ تغییرات همسو است و اطمینان می‌دهد که مستندات شما حرفه‌ای به نظر رسیده و با اکوسیستم‌های وسیع‌تر سازگار باقی می‌مانند. هر ورودی که ایجاد می‌کنید در یکی از شش نوع تغییر استاندارد توصیه‌شده توسط پروژه «Keep a Changelog» دسته‌بندی می‌شود: 1. **Added:** برای ویژگی‌های جدید که قابلیت‌های نرم‌افزار شما را گسترش می‌دهند. 2. **Changed:** برای تغییرات در قابلیت‌های موجود که نحوه عملکرد چیزها را تغییر می‌دهد. 3. **Deprecated:** برای ویژگی‌هایی که به‌زودی حذف می‌شوند و به کاربران هشدار می‌دهد تا مهاجرت کنند. 4. **Removed:** برای ویژگی‌هایی که به طور رسمی از کد بیس بازنشسته شده‌اند. 5. **Fixed:** برای هرگونه رفع باگ که مشکلات را حل کرده و پایداری را بهبود می‌بخشد. 6. **Security:** برای وصله‌های حیاتی جهت رفع آسیب‌پذیری‌ها. این دسته‌بندی به کاربران کمک می‌کند تا یادداشت‌های انتشار شما را به سرعت اسکن کنند و دقیقاً آنچه را نیاز دارند بیابند، چه به دنبال ابزارهای جدید باشند و چه بررسی کنند که آیا یک باگ خاص برطرف شده است یا خیر. ## راهنمایی برای نوشتن ورودی‌های تأثیرگذار نوشتن یک ورودی خوب برای لاگ تغییرات یک هنر است. این کار نیاز به ایجاد تعادل بین دقت فنی و دسترسی‌پذیری دارد. Changelog Template فقط یک جعبه متن به شما نمی‌دهد؛ بلکه زمینه و راهنمایی لازم برای نوشتن ورودی‌هایی که اهمیت دارند را فراهم می‌کند. ما سه قانون ساده را توصیه می‌کنیم: - **از جملات تک‌خطی استفاده کنید:** مختصر بنویسید. یک نکته واضح در هر ورودی بهتر از یک پاراگراف متراکم است. - **از زمان گذشته استفاده کنید:** شما در حال توصیف چیزی هستید که *تغییر کرده است* (مثلاً «بهبود عملکرد جستجو» به جای «بهبود عملکرد جستجو»). - **دیدگاه کاربر را بپذیرید:** برای کسی بنویسید که از نرم‌افزار شما استفاده می‌کند، نه کسی که کد را نوشته است. به جای گفتن «بازنویسی بهینه‌ساز پرس‌وجوی SQL»، بگویید «عملکرد جستجو را ۵۰٪ بهبود بخشید». این افزونه حتی در مسائل فنی نیز کمک می‌کند—به‌طور خودکار ورودی‌های شما را با حروف بزرگ آغاز کرده و در صورت فراموشی، اطمینان حاصل می‌کند که با یک نقطه مناسب پایان می‌یابند. ## محیط کاری پر از ویژگی Changelog Template پر از ویژگی‌هایی است که باعث می‌شود مستندسازی بخشی طبیعی از گردش کار شما به نظر برسد: ### ۱. ایجاد سریع ورودی تب «Create» منطقه فرود شماست. نوع تغییر خود را انتخاب کنید، ورودی خود را تایپ کنید و «Add to Unreleased» را بزنید. به همین سادگی. دیگر نیازی به تعویض زمینه بین IDE و فایل Markdown فقط برای یادداشت کردن یک به‌روزرسانی سریع نیست. ### ۲. مدیریت پایدار «Unreleased» یکی از قدرتمندترین ویژگی‌های یک لاگ تغییرات خوب، بخش «Unreleased» است. این بخش به عنوان یک منطقه استقرار برای تمام تغییراتی که از آخرین نسخه رسمی ایجاد کرده‌اید عمل می‌کند. Changelog Template این بخش را برای شما مدیریت کرده و ورودی‌های شما را در حافظه محلی ذخیره می‌کند تا هر زمان که افزونه را باز کردید، آماده باشند. ### ۳. مرجع نسخه‌بندی معنایی (SemVer) نسخه‌بندی نباید یک بازی حدس و گمان باشد. تب «Reference» ما شامل یک راهنمای شروع سریع برای نسخه‌بندی معنایی (SemVer) است که به شما کمک می‌کند تصمیم بگیرید که انتشار بعدی شما باید نسخه Major، Minor یا Patch باشد: - **MAJOR:** برای تغییرات ناسازگار API. - **MINOR:** برای افزودن قابلیت‌ها به روشی که با نسخه‌های قبلی سازگار باشد. - **PATCH:** برای رفع باگ‌های سازگار با نسخه‌های قبلی. ### ۴. مرجع ابزارهای اتوماسیون برای تیم‌هایی که آماده برداشتن گام بعدی هستند، ما اشاره‌گرهایی به ابزارهای اتوماسیون استاندارد صنعت مانند `standard-version`، `release-it` و `semantic-release` ارائه می‌دهیم. این ابزارها دست در دست فرمت Markdown تولید شده توسط افزونه ما کار می‌کنند تا کل فرآیند انتشار شما را خودکار کنند. ### ۵. کپی با یک کلیک و خروجی Markdown هنگامی که آماده به‌روزرسانی فایل خود هستید، می‌توانید بخش «Unreleased» را به عنوان Markdown فرمت‌شده با یک کلیک کپی کنید. نیاز به شروع یک پروژه جدید دارید؟ از «Full CHANGELOG.md Starter Template» ما برای تولید یک فایل کامل و آماده استفاده کنید که شامل هدرها و لینک‌های لازم است. ## چرا یک لاگ تغییرات خوب اهمیت دارد؟ یک لاگ تغییرات که به خوبی نگهداری شود، چیزی بیش از یک لیست از به‌روزرسانی‌ها است؛ نشانی از یک پروژه سالم و بالغ است. این کار با نشان دادن اینکه پروژه فعالانه نگهداری می‌شود، **شفافیت** ایجاد می‌کند. با برجسته کردن تغییرات مهمی که ممکن است در غیر این صورت در میان صدها پیام کامیت دفن شوند، **ارتباطات** را تسهیل می‌کند. مهم‌تر از همه، **حرفه‌ای بودن** را نشان می‌دهد. وقتی کاربر یک CHANGELOG.md تمیز و سازمان‌یافته می‌بیند، می‌داند که می‌تواند به پروژه و توسعه‌دهنده پشت آن اعتماد کند. ## این برای چه کسانی است؟ - **توسعه‌دهندگان انفرادی:** پروژه‌های جانبی خود را سازماندهی کنید و از لحظات «سه ماه پیش چه کار کردم؟» اجتناب کنید. - **تیم‌های کوچک:** اطمینان حاصل کنید که همه در مورد پیشرفت پروژه هم‌نظر هستند بدون اینکه برای هر به‌روزرسانی کوچک نیاز به بردهای پیچیده جیرا باشد. - **مشارکت‌کنندگان متن‌باز:** با ارائه یادداشت‌های انتشار واضح و آسان برای خواندن، پروژه خود را برای کاربران جدید جذاب‌تر کنید. ## سهولت استفاده: بدون راه‌اندازی، بدون دردسر Changelog Template طوری طراحی شده است که تا زمانی که به آن نیاز ندارید، نامرئی باشد. هیچ تنظیمات پیچیده، هیچ حساب خارجی برای ایجاد و هیچ کلید API برای مدیریت وجود ندارد. این افزونه از حافظه محلی کروم برای خصوصی نگه داشتن داده‌های شما و دسترسی فقط روی دستگاه خودتان استفاده می‌کند. رابط کاربری مینیمالیستی و واکنش‌گرا است و کاملاً در نوار کناری یا ناحیه پاپ‌آپ مرورگر شما جای می‌گیرد. اجازه ندهید مستندات پروژه شما عقب بیفتد. همین امروز شروع به استفاده از **Changelog Template** کنید و به نرم‌افزار خود تاریخچه حرفه‌ای که شایسته آن است را بدهید.