Remove all links to Gemnasium

Fixes #267
This commit is contained in:
Olivier Lacan 2018-11-07 12:10:12 -05:00
parent 414fce9262
commit f4c0c0834f
19 changed files with 93 additions and 112 deletions

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -249,7 +248,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} je Ruby gem vytvořený týmem #{link_to "Vandamme", vandamme} je Ruby gem vytvořený týmem
#{link_to "Gemnasium", gemnasium}, který parsuje mnoho (ale ne všechny) Gemnasium, který parsuje mnoho (ale ne všechny)
changelogy open source projektů. changelogy open source projektů.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -259,7 +258,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} ist ein Ruby gem erstellt vom #{link_to "Vandamme", vandamme} ist ein Ruby gem erstellt vom
#{link_to "Gemnasium", gemnasium} Team, das viele (aber nicht alle) Gemnasium Team, das viele (aber nicht alle)
Changelogs von Open-Source-Projekten einlesen kann. Changelogs von Open-Source-Projekten einlesen kann.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -256,7 +255,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} is a Ruby gem created by the #{link_to "Vandamme", vandamme} is a Ruby gem created by the
#{link_to "Gemnasium", gemnasium} team and which parses many (but Gemnasium team and which parses many (but
not all) open source project changelogs. not all) open source project changelogs.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -264,7 +263,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} es una gema de Ruby creada por el #{link_to "Vandamme", vandamme} es una gema de Ruby creada por el
equipo de #{link_to "Gemnasium", gemnasium} que analiza equipo de Gemnasium que analiza
gramaticalmente muchos (pero no todos) los changelogs de proyectos gramaticalmente muchos (pero no todos) los changelogs de proyectos
open source. open source.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -43,7 +42,7 @@ pre {direction:ltr;text-align:left}
لاگ تغییرات چیست؟ لاگ تغییرات چیست؟
%p %p
لاگ تغییرات فایلی است که لیست تغییرات قابل توجه برای هر نسخه یک پروژه که بر اساس تاریخ مرتب شدند را شامل می‌شود لاگ تغییرات فایلی است که لیست تغییرات قابل توجه برای هر نسخه یک پروژه که بر اساس تاریخ مرتب شدند را شامل می‌شود
%h3#why %h3#why
%a.anchor{ href: "#why", aria_hidden: "true" } %a.anchor{ href: "#why", aria_hidden: "true" }
@ -150,8 +149,8 @@ pre {direction:ltr;text-align:left}
Ignoring Deprecations Ignoring Deprecations
%p %p
وقتی مردم از یک نسخه به نسخه دیگری به روز رسانی می‌کنند، باید کاملاً شفاف باشد که چه موقع چیزی می‌شکند. وقتی مردم از یک نسخه به نسخه دیگری به روز رسانی می‌کنند، باید کاملاً شفاف باشد که چه موقع چیزی می‌شکند.
باید ممکن باشد که به نسخه‌ای که منسوخ شده‌ها (deprecations) را فهرست کند، آنچه منسوخ شده را حذف کند و سپس به نسخه‌ای به روز رسانی کرد که منسوخ شده‌ها را برداشته است. باید ممکن باشد که به نسخه‌ای که منسوخ شده‌ها (deprecations) را فهرست کند، آنچه منسوخ شده را حذف کند و سپس به نسخه‌ای به روز رسانی کرد که منسوخ شده‌ها را برداشته است.
%p %p
حتی اگر کار دیگری نمی‌کنید، منسوخ شده‌ها، امکانات حذف شده یا هر نوع تغییرات منجر به شکست را در لاگ تغییرات فهرست کنید حتی اگر کار دیگری نمی‌کنید، منسوخ شده‌ها، امکانات حذف شده یا هر نوع تغییرات منجر به شکست را در لاگ تغییرات فهرست کنید
@ -165,9 +164,9 @@ pre {direction:ltr;text-align:left}
فرمت‌های تاریخ محلی در سراسر جهان متفاوت است و معمولاً مشکل است که یک فرمت انسان پسند تاریخ پیدا کنیم که همه درکش کنند. فرمت‌های تاریخ محلی در سراسر جهان متفاوت است و معمولاً مشکل است که یک فرمت انسان پسند تاریخ پیدا کنیم که همه درکش کنند.
مزیت استفاده از فرمت‌هایی مثل مزیت استفاده از فرمت‌هایی مثل
<code>2017-07-17</code> <code>2017-07-17</code>
این است که شما ترتیب بزرگترین به کوچگترین واحدها را رعایت می کنید: سال، ماه و روز. این است که شما ترتیب بزرگترین به کوچگترین واحدها را رعایت می کنید: سال، ماه و روز.
این فرمت همچنین بر خلاف بعضی فرمت‌های محلی که که جای اعداد ماه و روز را عوضی می‌کنند، با فرمت‌های دو پهلوی تاریخ همپوشانی ندارد، این فرمت همچنین بر خلاف بعضی فرمت‌های محلی که که جای اعداد ماه و روز را عوضی می‌کنند، با فرمت‌های دو پهلوی تاریخ همپوشانی ندارد،
این دلایل، و این واقعیت که این فرمت یک این دلایل، و این واقعیت که این فرمت یک
#{link_to "استاندارد ایزو", iso} است، دلیل پیشنهاد شدن این فرمت برای مدخل‌های لاگ تغییرات است. #{link_to "استاندارد ایزو", iso} است، دلیل پیشنهاد شدن این فرمت برای مدخل‌های لاگ تغییرات است.
%aside %aside
@ -190,9 +189,9 @@ pre {direction:ltr;text-align:left}
وجود دارد. این نارسا و ناکافی هستند. وجود دارد. این نارسا و ناکافی هستند.
%p %p
این پروژه قصد دارد این پروژه قصد دارد
= link_to "یک قرارداد بهتر برای لاگ تغییرات باشد", changelog = link_to "یک قرارداد بهتر برای لاگ تغییرات باشد", changelog
که از مشاهده و جمع آوری شیوه‌های خوب جامعه متن باز آمده است که از مشاهده و جمع آوری شیوه‌های خوب جامعه متن باز آمده است
%p %p
از نقد سالم، بحث و گفتگو و پیشنهادات برای بهبود از نقد سالم، بحث و گفتگو و پیشنهادات برای بهبود
@ -204,7 +203,7 @@ pre {direction:ltr;text-align:left}
فایل لاگ تغییرات باید چه نامیده شود؟ فایل لاگ تغییرات باید چه نامیده شود؟
%p %p
نامش را <code>CHANGELOG.md</code> بگذارید. بعضی پروژه‌ها از نامش را <code>CHANGELOG.md</code> بگذارید. بعضی پروژه‌ها از
<code>HISTORY</code>, <code>NEWS</code> یا <code>RELEASES</code> استفاده می‌کنند. <code>HISTORY</code>, <code>NEWS</code> یا <code>RELEASES</code> استفاده می‌کنند.
%p %p
@ -215,16 +214,16 @@ pre {direction:ltr;text-align:left}
Release های گیت‌هاب چطور؟ Release های گیت‌هاب چطور؟
%p %p
ابتکار فوق‌العاده‌ای است. #{link_to "Release", ghr} ها می‌توانند برای تبدیل برچسب‌های ساده گیت ابتکار فوق‌العاده‌ای است. #{link_to "Release", ghr} ها می‌توانند برای تبدیل برچسب‌های ساده گیت
(مثلاً برچسبی به نام <code>v1.0.0</code>) (مثلاً برچسبی به نام <code>v1.0.0</code>)
به یادداشت عرضه (Release Note) غنی استفاده شوند. یا با اضافه کردن دستی یادداشت عرضه یا با گرفتن پیام‌های حاشیه‌نویسی شده برچسب گیت و تبدیلشان به یادداشت. به یادداشت عرضه (Release Note) غنی استفاده شوند. یا با اضافه کردن دستی یادداشت عرضه یا با گرفتن پیام‌های حاشیه‌نویسی شده برچسب گیت و تبدیلشان به یادداشت.
%p %p
Release های گیت‌هاب لاگ‌های تغییرات غیرقابل حمل که فقط در گیت‌هاب به کاربران نمایش داده می‌شوند را ایجاد می‌کنند. Release های گیت‌هاب لاگ‌های تغییرات غیرقابل حمل که فقط در گیت‌هاب به کاربران نمایش داده می‌شوند را ایجاد می‌کنند.
شبیه کردن‌شان به فرمت پیشنهادی این سند ممکن است اما تلاش بیشتری می‌طلبد. شبیه کردن‌شان به فرمت پیشنهادی این سند ممکن است اما تلاش بیشتری می‌طلبد.
%p %p
نسخه فعلی release های گیت‌هاب نسبت به فایل‌های با حرف بزرگ دیگر نسخه فعلی release های گیت‌هاب نسبت به فایل‌های با حرف بزرگ دیگر
(<code>README</code>, <code>CONTRIBUTING</code>, غیره.) (<code>README</code>, <code>CONTRIBUTING</code>, غیره.)
کمتر توسط کاربران پیدا می‌شوند کمتر توسط کاربران پیدا می‌شوند
مشکل کوچک دیگر این است که رابط کاربری فعلی امکان ایجاد پیوند به لاگ کامیت‌ها را بین هر عرضه نمی‌دهد. مشکل کوچک دیگر این است که رابط کاربری فعلی امکان ایجاد پیوند به لاگ کامیت‌ها را بین هر عرضه نمی‌دهد.
@ -238,7 +237,7 @@ pre {direction:ltr;text-align:left}
%p %p
#{link_to "Vandamme", vandamme} یک روبی gem ساخته شده توسط تیم #{link_to "Vandamme", vandamme} یک روبی gem ساخته شده توسط تیم
#{link_to "Gemnasium", gemnasium} است که اغلب (اما نه همه) لاگ تغییرات پروژه‌های متن باز را پارس می‌کند. Gemnasium است که اغلب (اما نه همه) لاگ تغییرات پروژه‌های متن باز را پارس می‌کند.
%h4#yanked %h4#yanked
@ -271,7 +270,7 @@ pre {direction:ltr;text-align:left}
چطور می‌توانم مشارکت کنیم؟ چطور می‌توانم مشارکت کنیم؟
%p %p
این سند <strong>حقیقت</strong> نیست; این نظر به دقت در نظر گرفته شده من به همراه اطلاعات و مثال‌هایی است که من گردآوری کردم این سند <strong>حقیقت</strong> نیست; این نظر به دقت در نظر گرفته شده من به همراه اطلاعات و مثال‌هایی است که من گردآوری کردم
%p %p
این سند برای آن است که جامعه نرم‌افزاری به اجماع برسند. معتقدم بحث و گفتگو به اندازه نتیجه نهایی مهم است این سند برای آن است که جامعه نرم‌افزاری به اجماع برسند. معتقدم بحث و گفتگو به اندازه نتیجه نهایی مهم است

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -258,7 +257,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} est une Ruby gem créée par l'équipe #{link_to "Vandamme", vandamme} est une Ruby gem créée par l'équipe
#{link_to "Gemnasium", gemnasium} qui parse les changelogs de Gemnasium qui parse les changelogs de
beaucoup (mais pas tous) de projets open source. beaucoup (mais pas tous) de projets open source.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -252,7 +251,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} je Ruby gem koji je kreirao #{link_to "Vandamme", vandamme} je Ruby gem koji je kreirao
#{link_to "Gemnasium", gemnasium} tim i može parsati mnoge (ali Gemnasium tim i može parsati mnoge (ali
ne sve) changeloge projekata otvorenog koda. ne sve) changeloge projekata otvorenog koda.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -34,15 +33,15 @@ version: 1.0.0
%a.anchor{ href: "#what", aria_hidden: "true" } %a.anchor{ href: "#what", aria_hidden: "true" }
Apa itu changelog? Apa itu changelog?
%p %p
Changelog adalah sebuah file yang berisi daftar perubahan yang Changelog adalah sebuah file yang berisi daftar perubahan yang
diurutkan secara kronologis untuk setiap versi dari sebuah project. diurutkan secara kronologis untuk setiap versi dari sebuah project.
%h3#why %h3#why
%a.anchor{ href: "#why", aria_hidden: "true" } %a.anchor{ href: "#why", aria_hidden: "true" }
Kenapa perlu untuk mencatat changelog? Kenapa perlu untuk mencatat changelog?
%p %p
Supaya pengguna dan kontributor lebih mudah melihat perubahan Supaya pengguna dan kontributor lebih mudah melihat perubahan
apa saja yang terjadi di setiap rilis (atau versi) dari sebuah project. apa saja yang terjadi di setiap rilis (atau versi) dari sebuah project.
@ -50,10 +49,10 @@ version: 1.0.0
%a.anchor{ href: "#who", aria_hidden: "true" } %a.anchor{ href: "#who", aria_hidden: "true" }
Siapa yang butuh changelog? Siapa yang butuh changelog?
%p %p
Semua orang membutuhkannya. Baik pengguna ataupun pengembang, setiap Semua orang membutuhkannya. Baik pengguna ataupun pengembang, setiap
orang yang menggunakan perangkat lunak adalah manusia yang peduli dengan orang yang menggunakan perangkat lunak adalah manusia yang peduli dengan
apa yang ada di perangkat lunak tersebut. Mereka ingin tahu apa apa yang ada di perangkat lunak tersebut. Mereka ingin tahu apa
dan kenapa terjadi perubahan. dan kenapa terjadi perubahan.
.good-practices .good-practices
@ -68,11 +67,11 @@ version: 1.0.0
%ul %ul
%li %li
Changelog ditulis untuk <em>manusia</em>, bukan mesin. Changelog ditulis untuk <em>manusia</em>, bukan mesin.
%li %li
Harus ada catatan untuk setiap versi. Harus ada catatan untuk setiap versi.
%li %li
Setiap tipe perubahan yang sama harus dikelompokkan. Setiap tipe perubahan yang sama harus dikelompokkan.
%li %li
Versi dan seksi harus ditulis dalam bentuk link. Versi dan seksi harus ditulis dalam bentuk link.
%li %li
Versi yang terakhir harus ditulis di paling atas. Versi yang terakhir harus ditulis di paling atas.
@ -107,10 +106,10 @@ version: 1.0.0
.effort .effort
%h3#effort %h3#effort
%a.anchor{ href: "#effort", aria_hidden: "true" } %a.anchor{ href: "#effort", aria_hidden: "true" }
Bagaimana usaha untuk menjaga changelog tetap tercatat dengan benar? Bagaimana usaha untuk menjaga changelog tetap tercatat dengan benar?
%p %p
Sisakan bagian <code>Unreleased/Belum Dirilis</code> di bagian paling atas Sisakan bagian <code>Unreleased/Belum Dirilis</code> di bagian paling atas
file changelog untuk mencatat perubahan yang akan datang. file changelog untuk mencatat perubahan yang akan datang.
@ -121,13 +120,13 @@ version: 1.0.0
%li %li
People can see what changes they might expect in upcoming releases People can see what changes they might expect in upcoming releases
Orang-orang bisa melihat perubahan apa saja yang akan datang. Orang-orang bisa melihat perubahan apa saja yang akan datang.
%li %li
Saat waktu rilis datang, tinggal pindahkan bagian <code>Unreleased/Belum Dirilis</code> Saat waktu rilis datang, tinggal pindahkan bagian <code>Unreleased/Belum Dirilis</code>
ke catatan rilis versi baru di bawah. ke catatan rilis versi baru di bawah.
.bad-practices .bad-practices
%h3#bad-practices %h3#bad-practices
%a.anchor{ href: "#bad-practices", aria_hidden: "true" } %a.anchor{ href: "#bad-practices", aria_hidden: "true" }
Apakah changelog bisa menjadi tidak bermanfaat? Apakah changelog bisa menjadi tidak bermanfaat?
%p Bisa, berikut beberapa skenario ketika changelog menjadi tidak bermanfaat: %p Bisa, berikut beberapa skenario ketika changelog menjadi tidak bermanfaat:
@ -136,7 +135,7 @@ version: 1.0.0
%a.anchor{ href: "#log-diffs", aria_hidden: "true" } %a.anchor{ href: "#log-diffs", aria_hidden: "true" }
Menggunakan Commit log diffs sebagai changelog Menggunakan Commit log diffs sebagai changelog
%p %p
Menggunakan commit log diffs (catatan perbedaan setiap commit) bisa Menggunakan commit log diffs (catatan perbedaan setiap commit) bisa
membuat changelog susah untuk dibaca. Commit dengan judul yang tidak jelas, membuat changelog susah untuk dibaca. Commit dengan judul yang tidak jelas,
dokumentasi perubahan, dan sebagainya, malah akan membuat dokumentasi perubahan, dan sebagainya, malah akan membuat
@ -148,7 +147,7 @@ version: 1.0.0
Tujuan utama dari commit adalah untuk mencatat setiap perubahan dari source Tujuan utama dari commit adalah untuk mencatat setiap perubahan dari source
code. Beberapa project mengatur commitnya, beberapa tidak. code. Beberapa project mengatur commitnya, beberapa tidak.
%p %p
Tujuan dari changelog adalah untuk mencatat perubahan yang pantas Tujuan dari changelog adalah untuk mencatat perubahan yang pantas
untuk dicatat, bisa jadi beberapa commit dijadikan satu catatan untuk dicatat, bisa jadi beberapa commit dijadikan satu catatan
untuk lebih memudahkan pembaca. untuk lebih memudahkan pembaca.
@ -157,14 +156,14 @@ version: 1.0.0
%a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" } %a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" }
Mengabaikan Depcreations (fitur yang akan dihilangkan) Mengabaikan Depcreations (fitur yang akan dihilangkan)
%p %p
Saat menaikkan versi, harus ditulis dengan jelas apa saja Saat menaikkan versi, harus ditulis dengan jelas apa saja
yang kira-kira bisa membuat sistem tidak berjalan. Sebaiknya yang kira-kira bisa membuat sistem tidak berjalan. Sebaiknya
terdapat versi yang mencatat apa saja yang akan dihilangkan, terdapat versi yang mencatat apa saja yang akan dihilangkan,
lalu menghapus fitur yang dihilangkan, dan naikkan lagi ke versi lalu menghapus fitur yang dihilangkan, dan naikkan lagi ke versi
dengan fitur yang sudah dihilangkan. dengan fitur yang sudah dihilangkan.
%p %p
Jika kalian tidak merubah apapun, tetap catat fitur yang akan Jika kalian tidak merubah apapun, tetap catat fitur yang akan
dihilangkan, fitur yang sudah dihilangkan, dan perubahan-perubahan dihilangkan, fitur yang sudah dihilangkan, dan perubahan-perubahan
lain yang bisa membuat sistem tidak berjalan. lain yang bisa membuat sistem tidak berjalan.
@ -174,7 +173,7 @@ version: 1.0.0
%a.anchor{ href: "#confusing-dates", aria_hidden: "true" } %a.anchor{ href: "#confusing-dates", aria_hidden: "true" }
Perbedaan Format Tanggal Perbedaan Format Tanggal
%p %p
Format tanggal regional berbeda-beda sesuai dengan budaya masing-masing, Format tanggal regional berbeda-beda sesuai dengan budaya masing-masing,
dan seringkali perbedaan ini susah untuk dipahami dan dimengerti. dan seringkali perbedaan ini susah untuk dipahami dan dimengerti.
Penggunaan format tanggal <code>2017-07-17</code> lebih mudah untuk dimengerti, Penggunaan format tanggal <code>2017-07-17</code> lebih mudah untuk dimengerti,
@ -182,7 +181,7 @@ version: 1.0.0
Format ini juga merupakan #{link_to "ISO standard", iso}, sehingga Format ini juga merupakan #{link_to "ISO standard", iso}, sehingga
inilah yang dipakai untuk pencatatan changelog. inilah yang dipakai untuk pencatatan changelog.
%aside %aside
Ada beberapa permasalahan lainnya, bantu kami dengan beberapa antipatterns Ada beberapa permasalahan lainnya, bantu kami dengan beberapa antipatterns
dengan = link_to "mengirimkan issue", issues atau kirimkan pull request. dengan = link_to "mengirimkan issue", issues atau kirimkan pull request.
@ -196,7 +195,7 @@ version: 1.0.0
Is there a standard changelog format? Is there a standard changelog format?
Apakah ada standar untuk format changelog? Apakah ada standar untuk format changelog?
%p %p
Tidak, ada format GNU untuk changelog, atau format 2 paragraf GNU NEWS. Tidak, ada format GNU untuk changelog, atau format 2 paragraf GNU NEWS.
Keduanya tidak benar-benar cukup, gunakan format yang disetujui tim masing-masing. Keduanya tidak benar-benar cukup, gunakan format yang disetujui tim masing-masing.
@ -204,10 +203,10 @@ version: 1.0.0
Project ini ditujukan untuk Project ini ditujukan untuk
= link_to "membuat aturan changelog yang lebih baik", changelog = link_to "membuat aturan changelog yang lebih baik", changelog
berdasarkan observasi beberapa changelog di komunitas open source berdasarkan observasi beberapa changelog di komunitas open source
dan menyatukan mereka. dan menyatukan mereka.
%p %p
Kritik yang membangun, diskusi, dan saran untuk perbaikan Kritik yang membangun, diskusi, dan saran untuk perbaikan
= link_to "sangat diterima.", issues = link_to "sangat diterima.", issues
@ -218,7 +217,7 @@ version: 1.0.0
%p %p
Gunakan nama <code>CHANGELOG.md</code>, beberapa project Gunakan nama <code>CHANGELOG.md</code>, beberapa project
menggunakan <code>HISTORY</code>, <code>NEWS</code> atau <code>RELEASE</code>. menggunakan <code>HISTORY</code>, <code>NEWS</code> atau <code>RELEASE</code>.
%p %p
Sebenarnya tidak terlalu susah untuk menamai file changelog, cukup Sebenarnya tidak terlalu susah untuk menamai file changelog, cukup
@ -227,31 +226,31 @@ version: 1.0.0
%h4#github-releases %h4#github-releases
%a.anchor{ href: "#github-releases", aria_hidden: "true" } %a.anchor{ href: "#github-releases", aria_hidden: "true" }
Apa itu GitHub Releases? Apa itu GitHub Releases?
%p %p
#{link_to "Github Release", ghr} adalah salah satu #{link_to "Github Release", ghr} adalah salah satu
insiatif dari GitHub untuk membuat changelog berdasarkan git tags, insiatif dari GitHub untuk membuat changelog berdasarkan git tags,
contohnya, tag dengan nama <code>v1.0.0</code>. Isi dari changelog contohnya, tag dengan nama <code>v1.0.0</code>. Isi dari changelog
bisa ditulis manual atau menggunakan pesan yang ditulis bersamaan dengan bisa ditulis manual atau menggunakan pesan yang ditulis bersamaan dengan
tags. tags.
%p %p
GitHub Releases membuat changelog yang tidak portable dan hanya bisa GitHub Releases membuat changelog yang tidak portable dan hanya bisa
bekerja dengan baik di lingkup GitHub. Sangat mungkin untuk bekerja dengan baik di lingkup GitHub. Sangat mungkin untuk
membuat GitHub Releases terlihat mirip dengan format pencatatan changelog membuat GitHub Releases terlihat mirip dengan format pencatatan changelog
yang dijelaskan di sini, tapi butuh usaha ekstra. yang dijelaskan di sini, tapi butuh usaha ekstra.
%p %p
Versi GitHub releases yang sekarang juga tidak terlalu umum Versi GitHub releases yang sekarang juga tidak terlalu umum
untuk orang-orang, dan hanya bisa dibuka melalui sub menu untuk orang-orang, dan hanya bisa dibuka melalui sub menu
di GitHub, berbeda dengan file-file seperti di GitHub, berbeda dengan file-file seperti
(<code>README</code>, <code>CONTRIBUTING</code>, dsb.) yang (<code>README</code>, <code>CONTRIBUTING</code>, dsb.) yang
langsung terlihat saat project pertama kali dibuka. Keterbatasan lainnya langsung terlihat saat project pertama kali dibuka. Keterbatasan lainnya
adalah tidak adanya link di GitHub releases. adalah tidak adanya link di GitHub releases.
%h4#automatic %h4#automatic
%a.anchor{ href: "#automatic", aria_hidden: "true" } %a.anchor{ href: "#automatic", aria_hidden: "true" }
Apakah Changelog Bisa Diparse Secara Otomatis? Apakah Changelog Bisa Diparse Secara Otomatis?
%p %p
@ -260,23 +259,23 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} adalah Ruby Gem yang dibuat oleh tim #{link_to "Vandamme", vandamme} adalah Ruby Gem yang dibuat oleh tim
#{link_to "Gemnasium", gemnasium} yang bisa memparse (but Gemnasium yang bisa memparse (but
not all) changelog beberapa project open source. not all) changelog beberapa project open source.
%h4#yanked %h4#yanked
%a.anchor{ href: "#yanked", aria_hidden: "true" } %a.anchor{ href: "#yanked", aria_hidden: "true" }
Bagaimana dengan Rilis YANKED (rilis yang dibatalkan)? Bagaimana dengan Rilis YANKED (rilis yang dibatalkan)?
%p %p
Rilis yang dibatalkan adalah rilis yang dibatalkan, bisa jadi Rilis yang dibatalkan adalah rilis yang dibatalkan, bisa jadi
karena ada bug yang fatal dan permasalahan keamanan. Versi karena ada bug yang fatal dan permasalahan keamanan. Versi
ini sering tidak dimasukkan ke changelog, padahal seharusnya ditulis ini sering tidak dimasukkan ke changelog, padahal seharusnya ditulis
sebagaimana berikut. sebagaimana berikut.
%p <code>## 0.0.5 - 2014-12-13 [YANKED/DIBATALKAN]</code> %p <code>## 0.0.5 - 2014-12-13 [YANKED/DIBATALKAN]</code>
%p %p
Tag <code>[YANKED/DIBATALKAN]</code> ditulis dengan jelas supaya Tag <code>[YANKED/DIBATALKAN]</code> ditulis dengan jelas supaya
orang memperhatikannya, dan dikurung dengan kurung kotak supaya orang memperhatikannya, dan dikurung dengan kurung kotak supaya
mudah untuk diparse. mudah untuk diparse.
@ -286,7 +285,7 @@ version: 1.0.0
%a.anchor{ href: "#rewrite", aria_hidden: "true" } %a.anchor{ href: "#rewrite", aria_hidden: "true" }
Bolehkan Menulis Ulang Changelog? Bolehkan Menulis Ulang Changelog?
%p %p
Tentu saja, ada banyak alasan bagus untuk menulis ulang changelog, Tentu saja, ada banyak alasan bagus untuk menulis ulang changelog,
salah satunya untuk rilis-rilis yang lupa untuk dituliskan di salah satunya untuk rilis-rilis yang lupa untuk dituliskan di
beberapa project. beberapa project.
@ -301,11 +300,11 @@ version: 1.0.0
%a.anchor{ href: "#contribute", aria_hidden: "true" } %a.anchor{ href: "#contribute", aria_hidden: "true" }
Bagaimana Saya Bisa Berkontribusi? Bagaimana Saya Bisa Berkontribusi?
%p %p
Dokumen ini bukan kebenaran absolut, ini hanyalah opini yang dikumpulkan Dokumen ini bukan kebenaran absolut, ini hanyalah opini yang dikumpulkan
dari beberapa informasi dan contoh yang kami kumpulkan. dari beberapa informasi dan contoh yang kami kumpulkan.
%p %p
Ini karena kami ingin komunitasi terus berdiskusi untuk mencapai konsensus Ini karena kami ingin komunitasi terus berdiskusi untuk mencapai konsensus
yang terbaik untuk pencatatan changelog. yang terbaik untuk pencatatan changelog.
@ -316,7 +315,7 @@ version: 1.0.0
%a.anchor{ href: "#about-translation", aria_hidden: "true" } %a.anchor{ href: "#about-translation", aria_hidden: "true" }
Tentang Terjemahan Bahasa Indonesia Tentang Terjemahan Bahasa Indonesia
%p %p
Terjemahan Bahasa Indonesia diterjemahkan oleh #{link_to "Aditya Purwa", aditya} Terjemahan Bahasa Indonesia diterjemahkan oleh #{link_to "Aditya Purwa", aditya}
dan dikoreksi oleh #{link_to "Edi Santoso", edicyber}, silahkan dan dikoreksi oleh #{link_to "Edi Santoso", edicyber}, silahkan
sampaikan jika ada terjemahan yang lebih baik. sampaikan jika ada terjemahan yang lebih baik.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -250,7 +249,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} è una Ruby gem creata dal team #{link_to "Vandamme", vandamme} è una Ruby gem creata dal team
#{link_to "Gemnasium", gemnasium} ed è in grado di fare il parsing dei Gemnasium ed è in grado di fare il parsing dei
changelog di molti (ma non tutti) i progetti open source. changelog di molti (ma non tutti) i progetti open source.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -127,7 +126,7 @@ version: 1.0.0
커밋 로그 차이(Commit log diffs) 커밋 로그 차이(Commit log diffs)
%p %p
커밋 로그 차이를 changelog로 사용하는 것은 안좋은 생각입니다: 커밋 로그 차이를 changelog로 사용하는 것은 안좋은 생각입니다:
머지 커밋, 모호한 타이틀을 가진 커밋, 문서 변경 등 노이즈로 가득차 있습니다. 머지 커밋, 모호한 타이틀을 가진 커밋, 문서 변경 등 노이즈로 가득차 있습니다.
%p %p
@ -135,7 +134,7 @@ version: 1.0.0
어떤 프로젝트는 커밋을 정리하지만, 어떤 프로젝트는 하지 않습니다. 어떤 프로젝트는 커밋을 정리하지만, 어떤 프로젝트는 하지 않습니다.
%p %p
changelog 기입의 목적은 종종 다수의 커밋 중에서 주목할만한 차이를 changelog 기입의 목적은 종종 다수의 커밋 중에서 주목할만한 차이를
최종 사용자에게 명확하게 전달하기 위해 문서화하는 것입니다. 최종 사용자에게 명확하게 전달하기 위해 문서화하는 것입니다.
%h4#ignoring-deprecations %h4#ignoring-deprecations
@ -158,10 +157,10 @@ version: 1.0.0
%p %p
지역 날짜 포맷은 전세계에 걸쳐 다르고 종종 모두에게 직관적인 인간 친화적 날짜 포맷을 찾기 힘듭니다. 지역 날짜 포맷은 전세계에 걸쳐 다르고 종종 모두에게 직관적인 인간 친화적 날짜 포맷을 찾기 힘듭니다.
<code>2017-07-17</code> 같은 날짜 포맷(연, 월, 일)의 장점은 <code>2017-07-17</code> 같은 날짜 포맷(연, 월, 일)의 장점은
큰 단위부터 작은 단위의 순서를 따른다는 것입니다. 큰 단위부터 작은 단위의 순서를 따른다는 것입니다.
월과 일의 위치가 뒤바뀐 어떤 포맷과 다르게, 이 포맷은 다른 날짜 포맷과 모호하게 겹치는 부분이 없습니다. 월과 일의 위치가 뒤바뀐 어떤 포맷과 다르게, 이 포맷은 다른 날짜 포맷과 모호하게 겹치는 부분이 없습니다.
이런 이유와 이 포맷이 #{link_to "ISO standard", iso}라는 사실이 이런 이유와 이 포맷이 #{link_to "ISO standard", iso}라는 사실이
changelog 기입을 위해 이 날짜 포맷을 추천하는 이유입니다. changelog 기입을 위해 이 날짜 포맷을 추천하는 이유입니다.
%aside %aside
@ -203,7 +202,7 @@ version: 1.0.0
<code>HISTORY</code>, <code>NEWS</code> 또는 <code>RELEASES</code>를 사용합니다. <code>HISTORY</code>, <code>NEWS</code> 또는 <code>RELEASES</code>를 사용합니다.
%p %p
changelog 파일의 이름이 무슨 상관이냐고 생각하기 쉽겠지만, changelog 파일의 이름이 무슨 상관이냐고 생각하기 쉽겠지만,
왜 굳이 여러분의 사용자가 변경사항을 일관적으로 찾기 힘들도록 만드나요? 왜 굳이 여러분의 사용자가 변경사항을 일관적으로 찾기 힘들도록 만드나요?
%h4#github-releases %h4#github-releases
@ -211,17 +210,17 @@ version: 1.0.0
깃허브 릴리즈는 어떻게 하나요? 깃허브 릴리즈는 어떻게 하나요?
%p %p
이것은 훌륭한 이니셔티브입니다. #{link_to "릴리즈", ghr}는 이것은 훌륭한 이니셔티브입니다. #{link_to "릴리즈", ghr}는
직접 릴리즈 노트를 추가하거나 어노테이션된 깃 태그 메시지를 가져와서 노트로 바꿔 직접 릴리즈 노트를 추가하거나 어노테이션된 깃 태그 메시지를 가져와서 노트로 바꿔
간단한 깃 태그(예를 들어 <code>v1.0.0</code> 태그 간단한 깃 태그(예를 들어 <code>v1.0.0</code> 태그
)를 풍부한 릴리즈 노트로 전환시키는데 사용될 수 있습니다. )를 풍부한 릴리즈 노트로 전환시키는데 사용될 수 있습니다.
%p %p
깃허브 릴리즈는 이동 불가능한 깃허브 컨텍스트 내에서만 표시되는 changelog를 생성합니다. 깃허브 릴리즈는 이동 불가능한 깃허브 컨텍스트 내에서만 표시되는 changelog를 생성합니다.
Keep a Changelog 포맷처럼 보이게 만드는 게 가능하지만, 좀 더 복잡해지는 경향이 있습니다. Keep a Changelog 포맷처럼 보이게 만드는 게 가능하지만, 좀 더 복잡해지는 경향이 있습니다.
%p %p
전형적인 대문자 파일들과 달리(<code>README</code>, <code>CONTRIBUTING</code>, 등), 전형적인 대문자 파일들과 달리(<code>README</code>, <code>CONTRIBUTING</code>, 등),
깃허브 릴리즈의 현재 버전은 최종 사용자가 거의 찾아볼 수 없습니다. 깃허브 릴리즈의 현재 버전은 최종 사용자가 거의 찾아볼 수 없습니다.
다른 사소한 이슈는 인터페이스가 현재 각 릴리즈 사이에 로그를 커밋할 수 있는 링크를 제공하지 않는 것입니다. 다른 사소한 이슈는 인터페이스가 현재 각 릴리즈 사이에 로그를 커밋할 수 있는 링크를 제공하지 않는 것입니다.
@ -233,7 +232,7 @@ version: 1.0.0
사람들이 대단히 다양한 포맷과 파일 이름을 따르기 때문에 어렵습니다. 사람들이 대단히 다양한 포맷과 파일 이름을 따르기 때문에 어렵습니다.
%p %p
#{link_to "Vandamme", vandamme}은 #{link_to "Gemnasium", gemnasium} 팀에 의해 #{link_to "Vandamme", vandamme}은 Gemnasium 팀에 의해
생성된 루비잼이고 많은(전부는 아니고) 오픈소스 프로젝트의 changelog를 파싱합니다. 생성된 루비잼이고 많은(전부는 아니고) 오픈소스 프로젝트의 changelog를 파싱합니다.
@ -242,14 +241,14 @@ version: 1.0.0
삭제된 릴리즈(Yanked release)는 어떻게 하나요? 삭제된 릴리즈(Yanked release)는 어떻게 하나요?
%p %p
삭제된(Yanked) 릴리즈는 심각한 버그나 보안 이슈 때문에 소스에서 들어내버린 버전을 말합니다. 삭제된(Yanked) 릴리즈는 심각한 버그나 보안 이슈 때문에 소스에서 들어내버린 버전을 말합니다.
대게 이런 버전은 changelog에 아예 나오지도 않지만, 나와야 합니다. 이것이 삭제된 릴리즈를 대게 이런 버전은 changelog에 아예 나오지도 않지만, 나와야 합니다. 이것이 삭제된 릴리즈를
표시하는 방법입니다: 표시하는 방법입니다:
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code> %p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
%p %p
<code>[YANKED]</code> 태그가 요란한 이유가 있습니다. <code>[YANKED]</code> 태그가 요란한 이유가 있습니다.
사람들이 알아차리는 것이 중요합니다. 대괄호 안에 있기 때문에 프로그래밍적으로 파싱하기에도 용이합니다. 사람들이 알아차리는 것이 중요합니다. 대괄호 안에 있기 때문에 프로그래밍적으로 파싱하기에도 용이합니다.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -242,7 +241,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} is een Ruby gem van het #{link_to "Vandamme", vandamme} is een Ruby gem van het
#{link_to "Gemnasium", gemnasium} team wat de changelogs van veel (maar niet alle) Gemnasium team wat de changelogs van veel (maar niet alle)
open source projecten kan parsen. open source projecten kan parsen.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -247,7 +246,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} jest gemem Ruby stworzonym przez zespół #{link_to "Vandamme", vandamme} jest gemem Ruby stworzonym przez zespół
#{link_to "Gemnasium", gemnasium} i który parsuje wiele (ale nie wszystkie) Gemnasium i który parsuje wiele (ale nie wszystkie)
changelogów projektów open source. changelogów projektów open source.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -251,7 +250,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} é um gem Ruby criado pelo #{link_to "Vandamme", vandamme} é um gem Ruby criado pelo
time #{link_to "Gemnasium", gemnasium} e que analisa muitas time Gemnasium e que analisa muitas
(mas não todas) alterações de projetos de código aberto. (mas não todas) alterações de projetos de código aberto.
%h4#yanked %h4#yanked

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -245,7 +244,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} это гем для Руби, созданный командой #{link_to "Vandamme", vandamme} это гем для Руби, созданный командой
#{link_to "Gemnasium", gemnasium}, который парсит многие (но не все) Gemnasium, который парсит многие (но не все)
логи изменений проектов с открытым исходным кодом. логи изменений проектов с открытым исходным кодом.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -244,7 +243,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} je Ruby gem vytvorený tímom #{link_to "Vandamme", vandamme} je Ruby gem vytvorený tímom
#{link_to "Gemnasium", gemnasium}, ktorý parsuje mnohé (ale nie všetky) Gemnasium, ktorý parsuje mnohé (ale nie všetky)
changelogy projektov s otvoreným zdrojovým kódom. changelogy projektov s otvoreným zdrojovým kódom.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -171,7 +170,7 @@ version: 1.0.0
svårt att hitta ett användbart datumformat som känns intuitivt svårt att hitta ett användbart datumformat som känns intuitivt
för alla. Fördelen med datumformat så som för alla. Fördelen med datumformat så som
<code>2017-07-17</code> är att det följer storleksordningen från störst till <code>2017-07-17</code> är att det följer storleksordningen från störst till
minst: år, månad och dag. Detta format överlappar inte heller minst: år, månad och dag. Detta format överlappar inte heller
på ett tvetydligt sätt med andra datumformat, till skillnad från på ett tvetydligt sätt med andra datumformat, till skillnad från
lokala format som kan växla positionen på månad och dag. lokala format som kan växla positionen på månad och dag.
Dessa anledningar tillsammans med det faktum att detta datumformat är en Dessa anledningar tillsammans med det faktum att detta datumformat är en
@ -193,8 +192,8 @@ version: 1.0.0
Finns det ett standardformat på ändringsloggar? Finns det ett standardformat på ändringsloggar?
%p %p
Inte riktigt. #{link_to "GNU:s stilguide för ändringsloggar", gnustyle} och Inte riktigt. #{link_to "GNU:s stilguide för ändringsloggar", gnustyle} och
den #{link_to "två stycke långa GNU NEWS-filen", gnunews} med "riktlinjer" finns. den #{link_to "två stycke långa GNU NEWS-filen", gnunews} med "riktlinjer" finns.
Båda är bristfälliga och otillräckliga. Båda är bristfälliga och otillräckliga.
%p %p
@ -251,7 +250,7 @@ version: 1.0.0
%p %p
#{link_to "Vandamme", vandamme} är en Ruby gem skapad av gruppen #{link_to "Vandamme", vandamme} är en Ruby gem skapad av gruppen
#{link_to "Gemnasium", gemnasium} som tolkar många (men inte alla) Gemnasium som tolkar många (men inte alla)
ändringsloggar för öppen källkod. ändringsloggar för öppen källkod.
%h4#yanked %h4#yanked

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -250,7 +249,7 @@ version: 1.0.0
kullanıyorlar. kullanıyorlar.
%p %p
#{link_to "Vandamme", vandamme}, #{link_to "Gemnasium", gemnasium} #{link_to "Vandamme", vandamme}, Gemnasium
ekibi tarafından oluşturulmuş bir Ruby Gem'i ve bir çok (ama hepsi ekibi tarafından oluşturulmuş bir Ruby Gem'i ve bir çok (ama hepsi
değil) açık kaynak projenin değişiklik kayıtlarını okuyabiliyor. değil) açık kaynak projenin değişiklik kayıtlarını okuyabiliyor.

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/" - semver = "https://semver.org/"
@ -121,9 +120,9 @@ version: 1.0.0
%h3#bad-practices %h3#bad-practices
%a.anchor{ href: "#bad-practices", aria_hidden: "true" } %a.anchor{ href: "#bad-practices", aria_hidden: "true" }
有很糟糕的更新日志吗? 有很糟糕的更新日志吗?
%p 当然有,下面就是一些糟糕的方式。 %p 当然有,下面就是一些糟糕的方式。
%h4#log-diffs %h4#log-diffs
%a.anchor{ href: "#log-diffs", aria_hidden: "true" } %a.anchor{ href: "#log-diffs", aria_hidden: "true" }
使用git日志 使用git日志
@ -138,19 +137,19 @@ version: 1.0.0
%p %p
更新日志的目的则是记录重要的变更以供最终受众阅读,而记录范围通常涵盖多次提交。 更新日志的目的则是记录重要的变更以供最终受众阅读,而记录范围通常涵盖多次提交。
%h4#ignoring-deprecations %h4#ignoring-deprecations
%a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" } %a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" }
无视即将弃用功能 无视即将弃用功能
%p %p
当从一个版本升级至另一个时,人们应清楚(尽管痛苦)的知道哪些部分将出现问题。 当从一个版本升级至另一个时,人们应清楚(尽管痛苦)的知道哪些部分将出现问题。
应该允许先升级至一个列出哪些功能将会被弃用的版本,待去掉那些不再支持的部分后, 应该允许先升级至一个列出哪些功能将会被弃用的版本,待去掉那些不再支持的部分后,
再升级至把那些弃用功能真正移除的版本。 再升级至把那些弃用功能真正移除的版本。
%p %p
即使其他什么都不做也要在更新日志中列出derecationsremovals以及其他重大变动。 即使其他什么都不做也要在更新日志中列出derecationsremovals以及其他重大变动。
%h4#confusing-dates %h4#confusing-dates
%a.anchor{ href: "#confusing-dates", aria_hidden: "true" } %a.anchor{ href: "#confusing-dates", aria_hidden: "true" }
易混淆的日期格式 易混淆的日期格式
@ -170,7 +169,7 @@ version: 1.0.0
%h3#frequently-asked-questions %h3#frequently-asked-questions
%a.anchor{ href: "#frequently-asked-questions", aria_hidden: "true" } %a.anchor{ href: "#frequently-asked-questions", aria_hidden: "true" }
常见问题 常见问题
%h4#standard %h4#standard
%a.anchor{ href: "#standard", aria_hidden: "true" } %a.anchor{ href: "#standard", aria_hidden: "true" }
是否有一个标准化的更新日志格式? 是否有一个标准化的更新日志格式?
@ -204,7 +203,7 @@ version: 1.0.0
%h4#github-releases %h4#github-releases
%a.anchor{ href: "#github-releases", aria_hidden: "true" } %a.anchor{ href: "#github-releases", aria_hidden: "true" }
对于GitHub发布呢 对于GitHub发布呢
%p %p
这是个非常好的倡议。#{link_to "Releases", ghr}可通过手动添加发布日志或将带 这是个非常好的倡议。#{link_to "Releases", ghr}可通过手动添加发布日志或将带
有注释的git标签信息抓取后转换的方式将简单的git标签如一个叫<code>v1.0.0</code>的标签) 有注释的git标签信息抓取后转换的方式将简单的git标签如一个叫<code>v1.0.0</code>的标签)
@ -215,7 +214,7 @@ version: 1.0.0
多时间,但将之处理成更新日志格式是完全可能的。 多时间,但将之处理成更新日志格式是完全可能的。
%p %p
现行版本的GitHub发布不像哪些典型的大写文件(<code>README</code>, 现行版本的GitHub发布不像哪些典型的大写文件(<code>README</code>,
<code>CONTRIBUTING</code>, etc.),仍可以认为是不利于最终用户探索的。 <code>CONTRIBUTING</code>, etc.),仍可以认为是不利于最终用户探索的。
另一个小问题则是界面并不提供不同版本间commit日志的链接。 另一个小问题则是界面并不提供不同版本间commit日志的链接。
@ -225,18 +224,18 @@ version: 1.0.0
%p %p
非常困难,因为有各种不同的文件格式和命名。 非常困难,因为有各种不同的文件格式和命名。
%p %p
#{link_to "Vandamme", vandamme} 是一个Ruby程序 #{link_to "Vandamme", vandamme} 是一个Ruby程序
#{link_to "Gemnasium", gemnasium} 团队制作,可以解析多种 Gemnasium 团队制作,可以解析多种
(但绝对不是全部)开源库的更新日志。 (但绝对不是全部)开源库的更新日志。
%h4#yanked %h4#yanked
%a.anchor{ href: "#yanked", aria_hidden: "true" } %a.anchor{ href: "#yanked", aria_hidden: "true" }
那些后来撤下的版本怎么办? 那些后来撤下的版本怎么办?
%p %p
因为各种安全/重大bug原因被撤下的版本被标记'YANKED'。 因为各种安全/重大bug原因被撤下的版本被标记'YANKED'。
这些版本一般不出现在更新日志里,但建议他们出现。 这些版本一般不出现在更新日志里,但建议他们出现。

View File

@ -6,7 +6,6 @@ version: 1.0.0
--- ---
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" - changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md"
- gemnasium = "https://gemnasium.com/"
- gh = "https://github.com/olivierlacan/keep-a-changelog" - gh = "https://github.com/olivierlacan/keep-a-changelog"
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" - issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
- semver = "https://semver.org/lang/zh-TW/" - semver = "https://semver.org/lang/zh-TW/"
@ -220,7 +219,7 @@ version: 1.0.0
非常困難,各式各樣的提交訊息和檔案名稱難以完全掌握。 非常困難,各式各樣的提交訊息和檔案名稱難以完全掌握。
%p %p
另外,有些開源專案使用由 #{link_to "Gemnasium", gemnasium} 另外,有些開源專案使用由 Gemnasium
團隊開發的 #{link_to "Vandamme", vandamme} 團隊開發的 #{link_to "Vandamme", vandamme}
轉換更新日誌,或許可以當作參考。 轉換更新日誌,或許可以當作參考。