این ابزار درست کار نمی‌کند؟

دربارهٔ ابزار «تمیز کردن متن changelog آنلاین»

این ابزار فایل‌های CHANGELOG.md را فرمت و نرمال‌سازی می‌کند. ورودی‌های تغییرات موجود را تجزیه می‌کند، آنها را بر اساس نسخه و تاریخ مرتب می‌کند، عناوین بخش (Added/Changed/Deprecated/Removed/Fixed/Security) را نرمال‌سازی می‌کند، و یک changelog Markdown تمیز پیرو قرارداد Keep a Changelog خروجی می‌دهد.

یک changelog سازگار یک تلاش کوچک است که برای همه کسانی که یادداشت‌های انتشار شما را می‌خوانند بازپرداخت می‌کند: مشارکت‌کنندگان، کاربرانی که می‌خواهند بدانند چه چیز جدیدی است، و خود آینده شما که سعی می‌کند به یاد بیاورد یک ویژگی چه زمانی منتشر شد.

ابزار می‌تواند بین فرمت‌ها (free-form به Keep-a-Changelog) تبدیل کند، اشتباهات رایج (شماره نسخه‌های گمشده، ورودی‌های نامرتب) را برجسته کند، و یادداشت‌های انتشار گیت‌هاب را از ورودی‌های CHANGELOG شما تولید کند.

چطور از این ابزار استفاده کنم؟

چطور خطوط commit آزاد را به یک بخش Keep-a-Changelog تبدیل کنم؟

  1. خطوط commit خام را بچسبانید

    هر خلاصهٔ commit را در یک خط در فیلد «Commits (one per line)» قرار دهید. prefix‌های Conventional Commit شناخته می‌شوند: `feat:`، `fix:`، `docs:`، `chore:` و غیره. خطوط بدون prefix شناخته‌شده به `### Other` می‌روند.

  2. «اجرا» را بزنید

    خروجی یک فیلد `markdown` — بلوک Keep-a-Changelog-style گروه‌بندی‌شده در `### Added`، `### Fixed`، `### Changed`، `### Docs` و `### Other`. گروه‌های خالی حذف می‌شوند.

  3. ساختار خروجی

    خطوط پس از grouping متن اصلی خود را (منهای prefix) حفظ می‌کنند. تاریخ یا header نسخه به‌صورت خودکار تولید نمی‌شود — آن را خودتان اضافه کنید: یک خط `## [1.4.0] - 2026-05-19` بالای گروه‌های تولیدشده قبل از commit بچسبانید.

  4. نکات برای خروجی تمیز

    ابزار را روی خروجی `git log v1.3.0..HEAD --pretty=%s` اجرا کنید. subject‌های commit بد/مبهم باعث خطوط changelog بد می‌شوند؛ این AI-rewriting نیست، فقط مرتب‌سازی.