mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-28 08:14:06 +02:00
Convert all links to JSON data
This will remove a lot of redundant variable definitions from Haml translations and centralize everything so it's much easier to update links when the invariably change. As they have.
This commit is contained in:
Olivier Lacan
parent
ba58b80f8a
commit
5f596f251f
13
data/links.json
Normal file
13
data/links.json
Normal file
@ -0,0 +1,13 @@
|
||||
{
|
||||
"changelog": "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md",
|
||||
"gh": "https://github.com/olivierlacan/keep-a-changelog",
|
||||
"issues": "https://github.com/olivierlacan/keep-a-changelog/issues",
|
||||
"semver": "https://semver.org/",
|
||||
"shields": "https://shields.io/",
|
||||
"thechangelog": "https://changelog.com/podcast/127",
|
||||
"vandamme": "https://github.com/tech-angels/vandamme/",
|
||||
"isodate": "http://www.iso.org/iso/home/standards/iso8601.htm",
|
||||
"github_releases": "https://help.github.com/articles/creating-releases/",
|
||||
"gnustyle": "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs",
|
||||
"gnunews": "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
}
|
||||
@ -4,19 +4,6 @@ title: احتفظ بسجل التغيير
|
||||
language: ar
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="https://cdn.rawgit.com/rastikerdar/vazir-font/v19.0.0/dist/font-face.css">
|
||||
|
||||
<style>
|
||||
@ -33,7 +20,7 @@ p.yanked {direction:ltr;text-align:right}
|
||||
git |
|
||||
مع سجلات التغيير |
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -84,7 +71,7 @@ p.yanked {direction:ltr;text-align:right}
|
||||
%li
|
||||
يتم عرض تاريخ إصدار كل نسخة.
|
||||
%li
|
||||
اذكر ما إذا كنت تتبع #{link_to "الأصدرة الدلالية" , semver}.
|
||||
اذكر ما إذا كنت تتبع #{link_to "الأصدرة الدلالية" , data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types أنواع التغييرات
|
||||
@ -170,7 +157,7 @@ p.yanked {direction:ltr;text-align:right}
|
||||
<code> 2017-07-17 </code>
|
||||
في أنها تتبع ترتيب الوحدات الأكبر إلى الأصغر: السنة والشهر واليوم. لا يتداخل هذا التنسيق بطرق غامضة مع تنسيقات التاريخ الأخرى ، على عكس بعض التنسيقات الإقليمية التي تغير موضع أرقام الشهر واليوم.
|
||||
بما أن تنسيق التاريخ هذا هو
|
||||
#{link_to "standard ISO" , iso}
|
||||
#{link_to "standard ISO" , data.links.isodate}
|
||||
فإنه تنسيق التاريخ الموصى به لفصول سجلات التغيير.
|
||||
|
||||
%aside
|
||||
@ -187,15 +174,15 @@ p.yanked {direction:ltr;text-align:right}
|
||||
%p
|
||||
ليس حقا.
|
||||
هناك إرشادات
|
||||
#{link_to "GNU changelog style guide", gnustyle} أو #{link_to "two-paragraph-long GNU NEWS file", gnunews} .
|
||||
#{link_to "GNU changelog style guide", data.links.gnustyle} أو #{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews} .
|
||||
كلاهما إما غير كافٍ أو غير مناسب.
|
||||
%p
|
||||
يهدف هذا المشروع إلى أن يكون
|
||||
= link_to "تحسين الصيغة الاصلاحية لسجلات التغيير.", changelog
|
||||
= link_to "تحسين الصيغة الاصلاحية لسجلات التغيير.", data.links.changelog
|
||||
تمت صياغته من مراقبة الممارسات الجيدة في مجتمع المصادر المفتوحة وجمعها.
|
||||
%p
|
||||
كل من النقد السليم والمناقشة والاقتراحات للتحسين
|
||||
= link_to "مرحبٌ بها" , issues
|
||||
= link_to "مرحبٌ بها" , data.links.issue
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -217,7 +204,7 @@ p.yanked {direction:ltr;text-align:right}
|
||||
|
||||
%p
|
||||
إنها مبادرة رائعة.
|
||||
يمكن استخدام #{link_to "الإصدارات", ghr}
|
||||
يمكن استخدام #{link_to "الإصدارات", data.links.github_releases}
|
||||
لتحويل علامات
|
||||
git
|
||||
البسيطة
|
||||
@ -248,7 +235,7 @@ p.yanked {direction:ltr;text-align:right}
|
||||
يصعب فعل ذلك لأن الأشخاص يتبعون تنسيقات وأسماء ملفات مختلفة تمامًا.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme}
|
||||
#{link_to "Vandamme", data.links.vandamme}
|
||||
هو جوهرة
|
||||
Ruby
|
||||
تم إنشاؤها بواسطة فريق
|
||||
@ -296,9 +283,9 @@ p.yanked {direction:ltr;text-align:right}
|
||||
هذا لأنني أريد أن يتوصل مجتمعنا إلى إجماع. أعتقد أن المناقشة لا تقل أهمية عن النتيجة النهائية.
|
||||
|
||||
%p
|
||||
لذا يرجى <strong>#{link_to "المشاركة", gh}</strong>.
|
||||
لذا يرجى <strong>#{link_to "المشاركة", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 محادثات
|
||||
%p
|
||||
حضرت #{link_to "بودكاست سجلات التغيير" , thechangelog} للحديث عن سبب اهتمام المشرفين والمساهمين بسجلات التغيير ، وكذلك عن الدوافع وراء هذا المشروع.
|
||||
حضرت #{link_to "بودكاست سجلات التغيير" , data.links.thechangelog} للحديث عن سبب اهتمام المشرفين والمساهمين بسجلات التغيير ، وكذلك عن الدوافع وراء هذا المشروع.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Udržuj Changelog
|
||||
language: cs
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Udržuj Changelog
|
||||
%h2 Nenech své kamarády sypat git logy do changelogů.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Verze
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -75,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
U každé verze je poznamenáno datum jejího vydání.
|
||||
%li
|
||||
Zmiňte, zda se držíte #{link_to "Sémantického verzování", semver}
|
||||
Zmiňte, zda se držíte #{link_to "Sémantického verzování", data.links.semver}
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Typy změn
|
||||
@ -168,12 +157,12 @@ version: 1.0.0
|
||||
jednotek od největší po nejmenší: rok, měsíc a den. Tento formát
|
||||
se navíc nepřekrývá s jinými, narozdíl od některých regionálních
|
||||
formátů, které prohazují pozici měsíce a dne. Díky těmto důvodům,
|
||||
a také faktu, že je tento formát #{link_to "ISO standard", iso},
|
||||
a také faktu, že je tento formát #{link_to "ISO standard", data.links.isodate},
|
||||
je doporučeným formátem pro záznamy v changelogu.
|
||||
|
||||
%aside
|
||||
Je toho však víc. Pomozte mi sesbírat tyto antipatterny
|
||||
= link_to "otevřením issue", issues
|
||||
= link_to "otevřením issue", data.links.issue
|
||||
nebo pull requestu.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -191,13 +180,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Tento projekt má za cíl být
|
||||
= link_to "lepší konvencí pro changelog.", changelog
|
||||
= link_to "lepší konvencí pro changelog.", data.links.changelog
|
||||
Pochází z pozorování osvědčených postupů v open source komunitě a jejich
|
||||
shromažďování.
|
||||
|
||||
%p
|
||||
Zdravá kritika, diskuse a návrhy na zlepšení
|
||||
= link_to "jsou vítány.", issues
|
||||
= link_to "jsou vítány.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -218,7 +207,7 @@ version: 1.0.0
|
||||
A co GitHub Releases?
|
||||
|
||||
%p
|
||||
Je to skvělá iniciativa. Služba #{link_to "Releases", ghr} může být
|
||||
Je to skvělá iniciativa. Služba #{link_to "Releases", data.links.github_releases} může být
|
||||
použita na proměnu obyčejných git tagů (například tag s názvem
|
||||
<code>v1.0.0</code>) na bohaté poznámky k vydání manuálním přidáním
|
||||
daných poznámek, nebo může pullnout zprávy z anotovaných git tagů
|
||||
@ -247,7 +236,7 @@ version: 1.0.0
|
||||
souborů.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} je Ruby gem vytvořený týmem
|
||||
#{link_to "Vandamme", data.links.vandamme} je Ruby gem vytvořený týmem
|
||||
Gemnasium, který parsuje mnoho (ale ne všechny)
|
||||
changelogy open source projektů.
|
||||
|
||||
@ -297,11 +286,11 @@ version: 1.0.0
|
||||
Věřím, že diskuse je stejně důležitá jako konečný výsledek.
|
||||
|
||||
%p
|
||||
Takže prosím, <strong>#{link_to "přiložte ruku k dílu", gh}</strong>.
|
||||
Takže prosím, <strong>#{link_to "přiložte ruku k dílu", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Rozhovory
|
||||
%p
|
||||
Zúčastnil jsem se #{link_to "podcastu The Changelog", thechangelog},
|
||||
Zúčastnil jsem se #{link_to "podcastu The Changelog", data.links.thechangelog},
|
||||
abych promluvil o tom, proč by se správci projektů a přispěvatelé měli
|
||||
starat o changelogy a také o motivaci za tímto projektem.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Hold en changelog
|
||||
language: da
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Hold en changelog
|
||||
%h2 Du skal ikke lade dine venner smide git logs i changelogs.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -79,7 +66,7 @@ version: 1.1.0
|
||||
%li
|
||||
Udgivelsesdatoen for hver version vises.
|
||||
%li
|
||||
Nævn hvorvidt du følger #{link_to "Semantisk Versionering", semver}.
|
||||
Nævn hvorvidt du følger #{link_to "Semantisk Versionering", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Ændringstyper
|
||||
@ -177,7 +164,7 @@ version: 1.1.0
|
||||
følger rækkefølgen for største til mindste enhed: år, måned og dag.
|
||||
Dette format overlapper heller ikke på en tvetydig måde med andre
|
||||
datoformater, der ombytter måneden og daten. Af disse årsager, og
|
||||
det faktum at dette datoformat er en #{link_to "ISO standard", iso},
|
||||
det faktum at dette datoformat er en #{link_to "ISO standard", data.links.isodate},
|
||||
er dette det anbefalede datoformat for changelog-indlæg.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -197,7 +184,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
Der er mere. Hjælp mig med at samle disse fælder ved at
|
||||
= link_to "åbne et issue", issues
|
||||
= link_to "åbne et issue", data.links.issue
|
||||
eller et pull-request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -210,19 +197,19 @@ version: 1.1.0
|
||||
Er der et standard changelog-format?
|
||||
|
||||
%p
|
||||
Ikke rigtig. Der er #{link_to "GNU changelog style guide", gnustyle},
|
||||
eller #{link_to "two-paragraph-long GNU NEWS file", gnunews}. De
|
||||
Ikke rigtig. Der er #{link_to "GNU changelog style guide", data.links.gnustyle},
|
||||
eller #{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews}. De
|
||||
er begge utilstrækkelige eller uhensigtsmæssige.
|
||||
|
||||
%p
|
||||
Dette projekt sigter efter at være
|
||||
= link_to "en bedre changelog konvention.", changelog
|
||||
= link_to "en bedre changelog konvention.", data.links.changelog
|
||||
Det kommer af at observere god praksis i opensource-verdenen
|
||||
og samle disse.
|
||||
|
||||
%p
|
||||
Konstruktiv kritik diskussion og forbedringsforslag
|
||||
= link_to "er velkomne.", issues
|
||||
= link_to "er velkomne.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -244,7 +231,7 @@ version: 1.1.0
|
||||
Hvad med GitHub Releases?
|
||||
|
||||
%p
|
||||
Det er et godt initiativ. #{link_to "Releases", ghr} kan bruges
|
||||
Det er et godt initiativ. #{link_to "Releases", data.links.github_releases} kan bruges
|
||||
til at gøre simple git tags (for eksempel, et tag <code>v1.0.0</code>)
|
||||
til fyldige udgivelsesnoter ved manuelt at tilføje noter til disse
|
||||
eller bruge en annoteret git-tag-besked som udgivelsesnoter.
|
||||
@ -272,7 +259,7 @@ version: 1.1.0
|
||||
og filnavne.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} er en Ruby gem lavet af
|
||||
#{link_to "Vandamme", data.links.vandamme} er en Ruby gem lavet af
|
||||
holdet bag Gemnasium, som læser og fortolker mange (men ikke
|
||||
alle) open source projekters changelogs.
|
||||
|
||||
@ -322,11 +309,11 @@ version: 1.1.0
|
||||
Det er fordi, jeg gerne vil have at vores fællesskab når en konsensus.
|
||||
Jeg mener at diskussionen er lige så vigtig som slutresultatet.
|
||||
%p
|
||||
Så, <strong>#{link_to "vær med!", gh}</strong>
|
||||
Så, <strong>#{link_to "vær med!", data.links.repo}</strong>
|
||||
|
||||
.press
|
||||
%h3 Samtaler
|
||||
%p
|
||||
Jeg var med i #{link_to "The Changelog podcast", thechangelog} for
|
||||
Jeg var med i #{link_to "The Changelog podcast", data.links.thechangelog} for
|
||||
at snakke om, hvorfor vedligeholdere og bidragsydere bør bekymre sig
|
||||
om changelogs og også om motivationen bag dette projekt.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Keep a Changelog
|
||||
language: de
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Führe ein CHANGELOG
|
||||
%h2 Lass Deine Freunde nicht CHANGELOGs mit git logs füllen.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +66,7 @@ version: 1.0.0
|
||||
%li
|
||||
Das Release-Datum jeder Version muss angegeben sein.
|
||||
%li
|
||||
Gib an, ob du dich an die #{link_to "Semantische Versionierung", semver} hältst.
|
||||
Gib an, ob du dich an die #{link_to "Semantische Versionierung", data.links.semver} hältst.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Arten von Änderungen
|
||||
@ -174,12 +163,12 @@ version: 1.0.0
|
||||
im Rest der Welt ein roboterhaft aussehendes <code>2 June 2012</code>
|
||||
schreiben, aber es völlig unterschiedlich aussprechen. <code>2012-06-02</code>
|
||||
folgt der Logik vom größten zum kleinsten Wert, kann nicht mit anderen Formaten
|
||||
verwechselt werden und ist ein #{link_to "ISO Standard", iso}. Deshalb
|
||||
verwechselt werden und ist ein #{link_to "ISO Standard", data.links.isodate}. Deshalb
|
||||
ist es das empfohlene Datumsformat in Changelogs.
|
||||
|
||||
%aside
|
||||
Es gibt sicher noch mehr. Hilf mir alle schlechten Tipps zu sammeln, indem du
|
||||
= link_to "ein Issue eröffnest", issues
|
||||
= link_to "ein Issue eröffnest", data.links.issue
|
||||
oder einen Pull-Request erstellst.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -198,13 +187,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Dieses Projekt versucht
|
||||
= link_to "eine bessere Changelog Konvention zu sein.", changelog
|
||||
= link_to "eine bessere Changelog Konvention zu sein.", data.links.changelog
|
||||
Dazu beobachten wir bewährte Praktiken aus der Open Source Community
|
||||
und tragen sie zusammen.
|
||||
|
||||
%p
|
||||
Gesunde Kritik, Diskussionen und Verbesserungsvorschläge
|
||||
= link_to "sind herzlich willkommen.", issues
|
||||
= link_to "sind herzlich willkommen.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -227,7 +216,7 @@ version: 1.0.0
|
||||
Was ist mit GitHub Releases?
|
||||
|
||||
%p
|
||||
Prinzipiell sind #{link_to "GitHub Releases", ghr} eine gute Sache.
|
||||
Prinzipiell sind #{link_to "GitHub Releases", data.links.github_releases} eine gute Sache.
|
||||
Sie können dazu benutzt werden, um einfache Git Tags (zum Beispiel einen
|
||||
Tag namens <code>v1.0.0</code>) mit vielen Hinweisen zum Release
|
||||
auszustatten, indem man sie manuell bearbeitet, oder die Änderungen in eine
|
||||
@ -257,7 +246,7 @@ version: 1.0.0
|
||||
Dateinamen verwenden.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} ist ein Ruby gem erstellt vom
|
||||
#{link_to "Vandamme", data.links.vandamme} ist ein Ruby gem erstellt vom
|
||||
Gemnasium Team, das viele (aber nicht alle)
|
||||
Changelogs von Open-Source-Projekten einlesen kann.
|
||||
|
||||
@ -308,11 +297,11 @@ version: 1.0.0
|
||||
die Disskussion genauso wichtig ist wie das Endergebnis.
|
||||
|
||||
%p
|
||||
Also bitte <strong>#{link_to "bring dich ein", gh}</strong>.
|
||||
Also bitte <strong>#{link_to "bring dich ein", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Gespräche
|
||||
%p
|
||||
Ich habe im #{link_to "The Changelog podcast", thechangelog} darüber gesprochen,
|
||||
Ich habe im #{link_to "The Changelog podcast", data.links.thechangelog} darüber gesprochen,
|
||||
warum sich Entwickler und Mitwirkende eines Projekts um ein Changelog kümmern sollten,
|
||||
sowie meine Motivationen hinter diesem Projekt erklärt.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Keep a Changelog
|
||||
language: en
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Keep a Changelog
|
||||
%h2 Don’t let your friends dump git logs into changelogs.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
The release date of each version is displayed.
|
||||
%li
|
||||
Mention whether you follow #{link_to "Semantic Versioning", semver}.
|
||||
Mention whether you follow #{link_to "Semantic Versioning", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types of changes
|
||||
@ -176,12 +163,12 @@ version: 1.0.0
|
||||
overlap in ambiguous ways with other date formats, unlike some
|
||||
regional formats that switch the position of month and day numbers.
|
||||
These reasons, and the fact this date format is an
|
||||
#{link_to "ISO standard", iso}, are why it is the recommended date
|
||||
#{link_to "ISO standard", data.links.isodate}, are why it is the recommended date
|
||||
format for changelog entries.
|
||||
|
||||
%aside
|
||||
There’s more. Help me collect these antipatterns by
|
||||
= link_to "opening an issue", issues
|
||||
= link_to "opening an issue", data.links.issue
|
||||
or a pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -194,19 +181,19 @@ version: 1.0.0
|
||||
Is there a standard changelog format?
|
||||
|
||||
%p
|
||||
Not really. There's the #{link_to "GNU changelog style guide", gnustyle},
|
||||
or the #{link_to "two-paragraph-long GNU NEWS file", gnunews}
|
||||
Not really. There's the #{link_to "GNU changelog style guide", data.links.gnustyle},
|
||||
or the #{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews}
|
||||
"guideline". Both are inadequate or insufficient.
|
||||
|
||||
%p
|
||||
This project aims to be
|
||||
= link_to "a better changelog convention.", changelog
|
||||
= link_to "a better changelog convention.", data.links.changelog
|
||||
It comes from observing good practices in the open source
|
||||
community and gathering them.
|
||||
|
||||
%p
|
||||
Healthy criticism, discussion and suggestions for improvements
|
||||
= link_to "are welcome.", issues
|
||||
= link_to "are welcome.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -227,7 +214,7 @@ version: 1.0.0
|
||||
What about GitHub Releases?
|
||||
|
||||
%p
|
||||
It's a great initiative. #{link_to "Releases", ghr} can be used to
|
||||
It's a great initiative. #{link_to "Releases", data.links.github_releases} can be used to
|
||||
turn simple git tags (for example a tag named <code>v1.0.0</code>)
|
||||
into rich release notes by manually adding release notes or it can
|
||||
pull annotated git tag messages and turn them into notes.
|
||||
@ -254,7 +241,7 @@ version: 1.0.0
|
||||
file names.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} is a Ruby gem created by the
|
||||
#{link_to "Vandamme", data.links.vandamme} is a Ruby gem created by the
|
||||
Gemnasium team and which parses many (but
|
||||
not all) open source project changelogs.
|
||||
|
||||
@ -305,11 +292,11 @@ version: 1.0.0
|
||||
the discussion is as important as the end result.
|
||||
|
||||
%p
|
||||
So please <strong>#{link_to "pitch in", gh}</strong>.
|
||||
So please <strong>#{link_to "pitch in", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversations
|
||||
%p
|
||||
I went on #{link_to "The Changelog podcast", thechangelog}
|
||||
I went on #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
to talk about why maintainers and contributors should care about changelogs,
|
||||
and also about the motivations behind this project.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Keep a Changelog
|
||||
language: en
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Keep a Changelog
|
||||
%h2 Don’t let your friends dump git logs into changelogs.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.1.0
|
||||
%li
|
||||
The release date of each version is displayed.
|
||||
%li
|
||||
Mention whether you follow #{link_to "Semantic Versioning", semver}.
|
||||
Mention whether you follow #{link_to "Semantic Versioning", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types of changes
|
||||
@ -176,7 +163,7 @@ version: 1.1.0
|
||||
overlap in ambiguous ways with other date formats, unlike some
|
||||
regional formats that switch the position of month and day numbers.
|
||||
These reasons, and the fact this date format is an
|
||||
#{link_to "ISO standard", iso}, are why it is the recommended date
|
||||
#{link_to "ISO standard", data.links.isodate}, are why it is the recommended date
|
||||
format for changelog entries.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -195,7 +182,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
There’s more. Help me collect these antipatterns by
|
||||
= link_to "opening an issue", issues
|
||||
= link_to "opening an issue", data.links.issue
|
||||
or a pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -208,19 +195,19 @@ version: 1.1.0
|
||||
Is there a standard changelog format?
|
||||
|
||||
%p
|
||||
Not really. There's the #{link_to "GNU changelog style guide", gnustyle},
|
||||
or the #{link_to "two-paragraph-long GNU NEWS file", gnunews}
|
||||
Not really. There's the #{link_to "GNU changelog style guide", data.links.gnustyle},
|
||||
or the #{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews}
|
||||
"guideline". Both are inadequate or insufficient.
|
||||
|
||||
%p
|
||||
This project aims to be
|
||||
= link_to "a better changelog convention.", changelog
|
||||
= link_to "a better changelog convention.", data.links.changelog
|
||||
It comes from observing good practices in the open source
|
||||
community and gathering them.
|
||||
|
||||
%p
|
||||
Healthy criticism, discussion and suggestions for improvements
|
||||
= link_to "are welcome.", issues
|
||||
= link_to "are welcome.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -241,7 +228,7 @@ version: 1.1.0
|
||||
What about GitHub Releases?
|
||||
|
||||
%p
|
||||
It's a great initiative. #{link_to "Releases", ghr} can be used to
|
||||
It's a great initiative. #{link_to "Releases", data.links.github_releases} can be used to
|
||||
turn simple git tags (for example a tag named <code>v1.0.0</code>)
|
||||
into rich release notes by manually adding release notes or it can
|
||||
pull annotated git tag messages and turn them into notes.
|
||||
@ -268,7 +255,7 @@ version: 1.1.0
|
||||
file names.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} is a Ruby gem created by the
|
||||
#{link_to "Vandamme", data.links.vandamme} is a Ruby gem created by the
|
||||
Gemnasium team and which parses many (but
|
||||
not all) open source project changelogs.
|
||||
|
||||
@ -319,11 +306,11 @@ version: 1.1.0
|
||||
the discussion is as important as the end result.
|
||||
|
||||
%p
|
||||
So please <strong>#{link_to "pitch in", gh}</strong>.
|
||||
So please <strong>#{link_to "pitch in", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversations
|
||||
%p
|
||||
I went on #{link_to "The Changelog podcast", thechangelog}
|
||||
I went on #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
to talk about why maintainers and contributors should care about changelogs,
|
||||
and also about the motivations behind this project.
|
||||
|
||||
@ -4,24 +4,13 @@ title: Mantenga un changelog
|
||||
language: es-ES
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Mantenga un changelog
|
||||
%h2
|
||||
No dejes que tus amigos usen el registro de git en los changelogs.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versión
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -79,7 +68,7 @@ version: 1.0.0
|
||||
%li
|
||||
Debe mostrar la fecha de publicación de cada versión.
|
||||
%li
|
||||
Indicar si el proyecto sigue el #{link_to "Versionamiento Semántico", semver}.
|
||||
Indicar si el proyecto sigue el #{link_to "Versionamiento Semántico", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Tipos de cambios
|
||||
@ -182,7 +171,7 @@ version: 1.0.0
|
||||
formato tampoco coincide de forma ambigua con otros formatos de
|
||||
fecha, a diferencia de algunos que intercambian la posición del mes
|
||||
y el día. Todo esto, junto al hecho de ser un
|
||||
#{link_to "estándar ISO", iso}, son los motivos por los que es el
|
||||
#{link_to "estándar ISO", data.links.isodate}, son los motivos por los que es el
|
||||
formato de fecha recomendado para las entradas del changelog.
|
||||
|
||||
%aside
|
||||
@ -206,13 +195,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Este proyecto apunta a ser
|
||||
= link_to "una mejor convención de changelog.", changelog
|
||||
= link_to "una mejor convención de changelog.", data.links.changelog
|
||||
Esto se da observando las buenas prácticas en la comunidad open
|
||||
source y recopilando las mismas.
|
||||
|
||||
%p
|
||||
Críticas saludables, discusión y sugerencias para mejoras
|
||||
= link_to "son bienvenidas.", issues
|
||||
= link_to "son bienvenidas.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -233,7 +222,7 @@ version: 1.0.0
|
||||
¿Y qué hay de los releases de Github?
|
||||
|
||||
%p
|
||||
Es una gran iniciativa. #{link_to "Los releases de Github", ghr}
|
||||
Es una gran iniciativa. #{link_to "Los releases de Github", data.links.github_releases}
|
||||
pueden ser utilizados para convertir simples etiquetas de git (por
|
||||
ejemplo una etiqueta llamada <code>v1.0.0</code>) en ricas notas de
|
||||
lanzamiento ya sea añadiendo estas manualmente o trayendo los
|
||||
@ -262,7 +251,7 @@ version: 1.0.0
|
||||
muy distintos.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} es una gema de Ruby creada por el
|
||||
#{link_to "Vandamme", data.links.vandamme} es una gema de Ruby creada por el
|
||||
equipo de Gemnasium que analiza
|
||||
gramaticalmente muchos (pero no todos) los changelogs de proyectos
|
||||
open source.
|
||||
@ -314,13 +303,13 @@ version: 1.0.0
|
||||
que la discusión es tan importante como el resultado final.
|
||||
|
||||
%p
|
||||
Así que por favor <strong>#{link_to "comienza a colaborar", gh}
|
||||
Así que por favor <strong>#{link_to "comienza a colaborar", data.links.repo}
|
||||
</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversaciones
|
||||
%p
|
||||
Fui a #{link_to "The Changelog podcast", thechangelog} para hablar
|
||||
Fui a #{link_to "The Changelog podcast", data.links.thechangelog} para hablar
|
||||
acerca del porqué los mantenedores y colaboradores deberían
|
||||
preocuparse por los changelogs, y también acerca de las motivaciones
|
||||
detrás de este proyecto.
|
||||
|
||||
@ -4,19 +4,6 @@ title: تاریخچهٔ تغییرات را نگه دارید
|
||||
language: fa-IR
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="https://cdn.rawgit.com/rastikerdar/vazir-font/v19.0.0/dist/font-face.css">
|
||||
|
||||
<style>
|
||||
@ -30,7 +17,7 @@ pre {direction:ltr;text-align:left}
|
||||
%h1 تاریخچهٔ تغییرات را نگه دارید
|
||||
%h2 نگذارید دوستانتان، خروجی git log را به اسم تاریخچهٔ تغییرات پروژه منتشر کنند.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -81,7 +68,7 @@ pre {direction:ltr;text-align:left}
|
||||
%li
|
||||
تاریخ انتشار هر نسخه را مشخص کنید.
|
||||
%li
|
||||
بگویید که آیا از #{link_to "نسخهبندی معنایی", semver} پیروی میکنید یا نه.
|
||||
بگویید که آیا از #{link_to "نسخهبندی معنایی", data.links.semver} پیروی میکنید یا نه.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types انواع تغییرات
|
||||
@ -153,7 +140,7 @@ pre {direction:ltr;text-align:left}
|
||||
تاریخهای گیجکننده
|
||||
|
||||
%p
|
||||
در هر نقطهای از دنیا شکل نمایش تاریخ متفاوت است؛ بنابراین پیداکردن یک قالب نمایش همهفهم برای کل مردم دنیا کار دشواری است. مزیت استفاده از قالبهایی مثل <code>2017-07-17</code> این است که در آن ترتیب بزرگترین به کوچکترین واحدها یعنی سال، ماه و روز رعایت شده است. این باعث میشود که برخلاف برخی از قالبها که در آن جای ماه و روز عوض شده، درک تاریخ دچار ابهام نشود. با درنظرگرفتن این دلایل واین واقعیت که این فرمت یک #{link_to "استاندارد ایزو", iso} است، این قالب را برای مدخلهای تاریخچهٔ تغییرات در نظر گرفتهایم.
|
||||
در هر نقطهای از دنیا شکل نمایش تاریخ متفاوت است؛ بنابراین پیداکردن یک قالب نمایش همهفهم برای کل مردم دنیا کار دشواری است. مزیت استفاده از قالبهایی مثل <code>2017-07-17</code> این است که در آن ترتیب بزرگترین به کوچکترین واحدها یعنی سال، ماه و روز رعایت شده است. این باعث میشود که برخلاف برخی از قالبها که در آن جای ماه و روز عوض شده، درک تاریخ دچار ابهام نشود. با درنظرگرفتن این دلایل واین واقعیت که این فرمت یک #{link_to "استاندارد ایزو", data.links.isodate} است، این قالب را برای مدخلهای تاریخچهٔ تغییرات در نظر گرفتهایم.
|
||||
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -165,7 +152,7 @@ pre {direction:ltr;text-align:left}
|
||||
|
||||
%aside
|
||||
اگر فکر میکنید جای موارد بیشتری در این لیست خالی است با
|
||||
= link_to "ارسال issue", issues
|
||||
= link_to "ارسال issue", data.links.issue
|
||||
یا ارسال Pull request به من کمک کنید.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -177,18 +164,18 @@ pre {direction:ltr;text-align:left}
|
||||
آیا فرمت استانداردی برای تاریخچهٔ تغییرات وجود دارد؟
|
||||
|
||||
%p
|
||||
حقیتاً نه. یک "راهنمای" #{link_to "راهنمای شیوه ثبت تاریخچهٔ تغییرات GNU", gnustyle},
|
||||
و یک #{link_to "فایل دو پاراگرافیِ بلند GNU NEWS", gnunews}
|
||||
حقیتاً نه. یک "راهنمای" #{link_to "راهنمای شیوه ثبت تاریخچهٔ تغییرات GNU", data.links.gnustyle},
|
||||
و یک #{link_to "فایل دو پاراگرافیِ بلند GNU NEWS", data.links.gnunews}
|
||||
وجود دارد که متأسفانه هردویشان نارسا و ناکافی هستند.
|
||||
|
||||
%p
|
||||
این پروژه قصد دارد
|
||||
= link_to "قراردادی بهتر برای ثبت تاریخچهٔ تغییرات باشد", changelog
|
||||
= link_to "قراردادی بهتر برای ثبت تاریخچهٔ تغییرات باشد", data.links.changelog
|
||||
که برگرفته از تجربیات جامعهٔ متنباز است.
|
||||
|
||||
%p
|
||||
از نقد سالم، بحثوگفتگو و پیشنهادها
|
||||
= link_to "استقبال میکنیم.", issues
|
||||
= link_to "استقبال میکنیم.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -206,7 +193,7 @@ pre {direction:ltr;text-align:left}
|
||||
%a.anchor{ href: "#github-releases", aria_hidden: "true" }
|
||||
چرا از ریلیزهای گیتهاب استفاده نکنیم؟
|
||||
%p
|
||||
ابتکار خوبی است. در هنگام انتشار #{link_to "Release", ghr}ها میتوانید به جای عرضهٔ یک نسخهٔ ساده (مثلاً یک برچسب خالی با نام <code>v1.0.0</code>)، لیست تغییرات آن نسخه را در قالب یک یادداشت، به آن برچسب ضمیمه کنید.
|
||||
ابتکار خوبی است. در هنگام انتشار #{link_to "Release", data.links.github_releases}ها میتوانید به جای عرضهٔ یک نسخهٔ ساده (مثلاً یک برچسب خالی با نام <code>v1.0.0</code>)، لیست تغییرات آن نسخه را در قالب یک یادداشت، به آن برچسب ضمیمه کنید.
|
||||
|
||||
%p
|
||||
اما نکته این است که تاریخچهٔ تغییراتی که در هر ریلیز گیتهاب منتشر میکنید فقط در خودِ گیتهاب قابل استفاده است و بهراحتی نمیتوانید آن را به جای دیگری منتقل کنید. شاید بتوانید بسیار شبیهش کنید به نسخهٔ پیشنهادی این سند ولی کار زحمتداری است.
|
||||
@ -223,7 +210,7 @@ pre {direction:ltr;text-align:left}
|
||||
مشکل است؛ چون افراد از فرمتها و نامگذاریهای متعددی برای این فایل استفاده میکنند.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} یک روبی gem است که توسط تیم
|
||||
#{link_to "Vandamme", data.links.vandamme} یک روبی gem است که توسط تیم
|
||||
Gemnasium ساخته شده است. این ابزار، تاریخچهٔ تغییرات پروژههای متنباز (البته نه همه) را بررسی میکند.
|
||||
|
||||
|
||||
@ -261,9 +248,9 @@ pre {direction:ltr;text-align:left}
|
||||
این به خاطر آن است که میخواهم جامعهٔ ما توسعهدهندهها به یک اتفاقنظر برسد. من معتقدم بحثوگفتگو بهاندازهٔ نتیجه مهم است.
|
||||
|
||||
%p
|
||||
بنابراین شما نیز <strong>#{link_to "دست به کار شوید", gh}</strong>.
|
||||
بنابراین شما نیز <strong>#{link_to "دست به کار شوید", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 گفتگو
|
||||
%p
|
||||
در #{link_to "پادکست Changelog", thechangelog}، گفتگویی داشتهام دربارهٔ انگیزهٔ پشت این پروژه و اینکه چرا متصدیان نگهداری و مشارکتکنندگان پروژهها باید به تاریخچهٔ تغییرات اهمیت بدهند.
|
||||
در #{link_to "پادکست Changelog", data.links.thechangelog}، گفتگویی داشتهام دربارهٔ انگیزهٔ پشت این پروژه و اینکه چرا متصدیان نگهداری و مشارکتکنندگان پروژهها باید به تاریخچهٔ تغییرات اهمیت بدهند.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Tenez un Changelog
|
||||
language: fr
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Tenez un Changelog
|
||||
%h2 Ne laissez pas vos amis utiliser les logs git comme changelogs
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +67,7 @@ version: 1.0.0
|
||||
%li
|
||||
La date de publication de chaque version est indiquée.
|
||||
%li
|
||||
Indiquer si le projet respecte le #{link_to "Versionnage Sémantique", semver}.
|
||||
Indiquer si le projet respecte le #{link_to "Versionnage Sémantique", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types de changements
|
||||
@ -178,7 +167,7 @@ version: 1.0.0
|
||||
l’écrivent de la façon robotique suivante « 2 Juin 2012 », alors qu’ils le
|
||||
prononcent différement. <code>2012-06-02</code> fonctionne logiquement, du plus grand
|
||||
au plus petit, ne laisse pas place à la confusion avec un autre format et
|
||||
est un #{link_to "standard ISO", iso}. C'est pour cela que ce format de date
|
||||
est un #{link_to "standard ISO", data.links.isodate}. C'est pour cela que ce format de date
|
||||
est recommandé pour les changelogs.
|
||||
|
||||
%aside
|
||||
@ -201,13 +190,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Ce projet vise à devenir
|
||||
= link_to "une meilleure convention pour les changelogs.", changelog
|
||||
= link_to "une meilleure convention pour les changelogs.", data.links.changelog
|
||||
Il a pour origine l'observation et le rassemblement des bonne pratiques dans
|
||||
la communauté open source.
|
||||
|
||||
%p
|
||||
Les critiques constructives, discussions et suggestions pour améliorer ce
|
||||
projet #{link_to "sont les bienvenues.", issues}.
|
||||
projet #{link_to "sont les bienvenues.", data.links.issue}.
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -229,7 +218,7 @@ version: 1.0.0
|
||||
Quid de GitHub Releases ?
|
||||
|
||||
%p
|
||||
C'est une excellente initiative. #{link_to "Releases", ghr} peut être
|
||||
C'est une excellente initiative. #{link_to "Releases", data.links.github_releases} peut être
|
||||
utilisé pour transformer de simples tags git (par exemple un tag nommé
|
||||
<code>v1.0.0</code>) en notes de publication riches soit en ajoutant
|
||||
manuellement des notes soit en utilisant les messages de tags gits annotés
|
||||
@ -256,7 +245,7 @@ version: 1.0.0
|
||||
de fichiers très différents.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} est une Ruby gem créée par l'équipe
|
||||
#{link_to "Vandamme", data.links.vandamme} est une Ruby gem créée par l'équipe
|
||||
Gemnasium qui parse les changelogs de
|
||||
beaucoup (mais pas tous) de projets open source.
|
||||
|
||||
@ -306,11 +295,11 @@ version: 1.0.0
|
||||
que la discussion est aussi importante que le résultat final.
|
||||
|
||||
%p
|
||||
Donc s'il vous plaît, <strong>#{link_to "participez", gh}</strong>.
|
||||
Donc s'il vous plaît, <strong>#{link_to "participez", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversations
|
||||
%p
|
||||
J'ai participé au podcast #{link_to "The Changelog", thechangelog}
|
||||
J'ai participé au podcast #{link_to "The Changelog", data.links.thechangelog}
|
||||
pour expliquer pourquoi les mainteneurs et contributeurs doivent se
|
||||
soucier des changelogs et également des motivations derrière ce projet.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Vodite changelog
|
||||
language: hr
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "http://5by5.tv/changelog/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Vodite Changelog
|
||||
%h2 Ne dajte prijateljima da trpaju git logove u changelogove.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Verzija
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
Datum izdavanja svake pojedine verzije treba biti vidljiv.
|
||||
%li
|
||||
Navesti prati li se #{link_to "Semantičko verzioniranje", semver}.
|
||||
Navesti prati li se #{link_to "Semantičko verzioniranje", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Vrste promjena
|
||||
@ -175,12 +162,12 @@ version: 1.0.0
|
||||
od veće prema manjoj jedinici: godina, mjesec, dan. Ovaj je format također
|
||||
teško zamijeniti s drugim regionalnim formatima, za razliku od nekih koji,
|
||||
primjerice mijenjaju poziciju oznake mjeseca i dana.
|
||||
Iz tog razloga, a i zbog toga što je navedeni format #{link_to "ISO standard", iso},
|
||||
Iz tog razloga, a i zbog toga što je navedeni format #{link_to "ISO standard", data.links.isodate},
|
||||
taj se format preporuča za changelog unose.
|
||||
|
||||
%aside
|
||||
Ali to nije sve. Pomozite prikupiti primjere loše prakse
|
||||
= link_to "otvorivši issue", issues
|
||||
= link_to "otvorivši issue", data.links.issue
|
||||
ili pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -193,19 +180,19 @@ version: 1.0.0
|
||||
Postoji li standardni changelog format?
|
||||
|
||||
%p
|
||||
Zapravo ne. Postoji #{link_to "GNU changelog stilski priručnik", gnustyle},
|
||||
i #{link_to "GNU NEWS file", gnunews}
|
||||
Zapravo ne. Postoji #{link_to "GNU changelog stilski priručnik", data.links.gnustyle},
|
||||
i #{link_to "GNU NEWS file", data.links.gnunews}
|
||||
"priručnik od dva odlomka". Nijedan nije adekvatan ni dovoljan.
|
||||
|
||||
%p
|
||||
Cilj je ovoga projekta
|
||||
= link_to "kvalitetniji changelog standard.", changelog
|
||||
= link_to "kvalitetniji changelog standard.", data.links.changelog
|
||||
Nastao je prikupljanjem primjera dobra prakse u
|
||||
open source zajednici.
|
||||
|
||||
%p
|
||||
Konstruktivna kritika, raprave i prijedlozi za poboljšanje
|
||||
= link_to "su dobrodošli.", issues
|
||||
= link_to "su dobrodošli.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -225,7 +212,7 @@ version: 1.0.0
|
||||
Što s GitHub Releases?
|
||||
|
||||
%p
|
||||
To je ozbiljna inicijativa. #{link_to "Releases", ghr} se mogu koristiti
|
||||
To je ozbiljna inicijativa. #{link_to "Releases", data.links.github_releases} se mogu koristiti
|
||||
kako bi git oznake (npr. git oznaka <code>v1.0.0</code>) pretvorili
|
||||
u opširnije bilješke o izdanju, upisujući ih ručno ili pak preuzimajući
|
||||
anotirane git oznake i pretvarajući ih u unose.
|
||||
@ -250,7 +237,7 @@ version: 1.0.0
|
||||
Teže, jer se koriste vrlo različiti formati, kao i nazivi datoteka.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} je Ruby gem koji je kreirao
|
||||
#{link_to "Vandamme", data.links.vandamme} je Ruby gem koji je kreirao
|
||||
Gemnasium tim i može parsati mnoge (ali
|
||||
ne sve) changeloge projekata otvorenog koda.
|
||||
|
||||
@ -301,11 +288,11 @@ version: 1.0.0
|
||||
također, da je i sama rasprava bitna kao i krajnjni rezultat.
|
||||
|
||||
%p
|
||||
Zato, molimo <strong>#{link_to "uskočite", gh}</strong>.
|
||||
Zato, molimo <strong>#{link_to "uskočite", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Razgovori
|
||||
%p
|
||||
Gostovao sam na #{link_to "The Changelog podcastu", thechangelog}
|
||||
Gostovao sam na #{link_to "The Changelog podcastu", data.links.thechangelog}
|
||||
gdje sam pokušao objasniti zašto začetnici projekata i suradnici trebaju
|
||||
brinuti o changelogovima te motivaciji iza ovog projekta.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Pencatatan Changelog
|
||||
language: id-ID
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- aditya = "https://github.com/adityapurwa/"
|
||||
- edicyber = "https://github.com/cyberid41"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Pencatatan Changelog
|
||||
%h2 Standarisasi pencatatan Changelog untuk kolaborasi yang lebih baik
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versi
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
Tanggal rilis setiap versi harus ditulis.
|
||||
%li
|
||||
Berikan informasi jika kalian menggunakan #{link_to "Semantic Versioning", semver}.
|
||||
Berikan informasi jika kalian menggunakan #{link_to "Semantic Versioning", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Jenis-jenis perubahan
|
||||
@ -175,12 +162,12 @@ version: 1.0.0
|
||||
dan seringkali perbedaan ini susah untuk dipahami dan dimengerti.
|
||||
Penggunaan format tanggal <code>2017-07-17</code> lebih mudah untuk dimengerti,
|
||||
karena diurutkan berdasarkan unit terbesar: tahun, bulan, dan tanggal.
|
||||
Format ini juga merupakan #{link_to "Standar ISO", iso}, sehingga
|
||||
Format ini juga merupakan #{link_to "Standar ISO", data.links.isodate}, sehingga
|
||||
inilah yang dipakai untuk pencatatan changelog.
|
||||
|
||||
%aside
|
||||
Ada beberapa permasalahan lainnya, bantu kami dengan beberapa antipatterns
|
||||
dengan #{link_to "mengirimkan issue", issues} atau kirimkan pull request.
|
||||
dengan #{link_to "mengirimkan issue", data.links.issue} atau kirimkan pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
%h3#frequently-asked-questions
|
||||
@ -197,13 +184,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Proyek ini ditujukan untuk
|
||||
= link_to "membuat aturan changelog yang lebih baik", changelog
|
||||
= link_to "membuat aturan changelog yang lebih baik", data.links.changelog
|
||||
berdasarkan observasi beberapa changelog di komunitas open source
|
||||
dan menyatukan mereka.
|
||||
|
||||
%p
|
||||
Kritik yang membangun, diskusi, dan saran untuk perbaikan
|
||||
= link_to "sangat diterima.", issues
|
||||
= link_to "sangat diterima.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -224,7 +211,7 @@ version: 1.0.0
|
||||
Apa itu GitHub Releases?
|
||||
|
||||
%p
|
||||
#{link_to "Github Release", ghr} adalah salah satu
|
||||
#{link_to "Github Release", data.links.github_releases} adalah salah satu
|
||||
insiatif dari GitHub untuk membuat changelog berdasarkan git tags,
|
||||
contohnya, tag dengan nama <code>v1.0.0</code>. Isi dari changelog
|
||||
bisa ditulis manual atau menggunakan pesan yang ditulis bersamaan dengan
|
||||
@ -253,7 +240,7 @@ version: 1.0.0
|
||||
changelog yang berbeda-beda.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} adalah Ruby Gem yang dibuat oleh tim
|
||||
#{link_to "Vandamme", data.links.vandamme} adalah Ruby Gem yang dibuat oleh tim
|
||||
Gemnasium yang bisa mem-parsing (tetapi tidak semua) changelog proyek open source.
|
||||
|
||||
|
||||
@ -303,7 +290,7 @@ version: 1.0.0
|
||||
yang terbaik untuk pencatatan changelog.
|
||||
|
||||
%p
|
||||
Jadi silahkan, <strong>#{link_to "kirimkan saran", gh}</strong>.
|
||||
Jadi silahkan, <strong>#{link_to "kirimkan saran", data.links.repo}</strong>.
|
||||
|
||||
%h4#about-translation
|
||||
%a.anchor{ href: "#about-translation", aria_hidden: "true" }
|
||||
@ -317,6 +304,6 @@ version: 1.0.0
|
||||
.press
|
||||
%h3 Percakapan
|
||||
%p
|
||||
Kami mengisi acara di #{link_to "Podcast Changelog", thechangelog}
|
||||
Kami mengisi acara di #{link_to "Podcast Changelog", data.links.thechangelog}
|
||||
untuk berbicara tentang kenapa maintainer dan kontributor harus peduli
|
||||
dengan changelog, dan motivasi dari proyek ini.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Keep a Changelog
|
||||
language: it-IT
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Tenere un Changelog
|
||||
%h2 Non lasciare che i tuoi amici facciano copia incolla dei git logs nei changelog.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versione
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -75,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
Viene mostrata la data di release di ogni versione.
|
||||
%li
|
||||
Si dichiara se il progetto segue il #{link_to "Versionamento Semantico", semver}.
|
||||
Si dichiara se il progetto segue il #{link_to "Versionamento Semantico", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Tipologie di cambiamenti
|
||||
@ -168,12 +157,12 @@ version: 1.0.0
|
||||
ha sovrapposizioni ambigue con altri formati di date, a differenza
|
||||
di alcuni formati regionali che scambiano la posizione del mese e del giorno.
|
||||
Queste motivazioni e il fatto che questo formato di data è uno
|
||||
#{link_to "standard ISO", iso} spiegano perché questo è il formato di date
|
||||
#{link_to "standard ISO", data.links.isodate} spiegano perché questo è il formato di date
|
||||
raccomandato per i changelog.
|
||||
|
||||
%aside
|
||||
C'è di più. Aiutatemi a collezionare altre situazioni cattive
|
||||
= link_to "aprendo un issue", issues
|
||||
= link_to "aprendo un issue", data.links.issue
|
||||
o una pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -191,13 +180,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Questo progetto vuole essere
|
||||
= link_to "una migliore convenzione per i file changelog.", changelog
|
||||
= link_to "una migliore convenzione per i file changelog.", data.links.changelog
|
||||
Per questo motivo osserviamo le migliori pratiche della comunità open source
|
||||
e le portiamo avanti.
|
||||
|
||||
%p
|
||||
Critiche, discussioni e suggerimenti per migliorare
|
||||
= link_to "sono ben accetti.", issues
|
||||
= link_to "sono ben accetti.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -218,7 +207,7 @@ version: 1.0.0
|
||||
Cosa dire delle GitHub Releases?
|
||||
|
||||
%p
|
||||
È una bella iniziativa. #{link_to "Releases", ghr} può essere usato
|
||||
È una bella iniziativa. #{link_to "Releases", data.links.github_releases} può essere usato
|
||||
per rendere semplice i git tags (per esempio il nome del tag
|
||||
<code>v1.0.0</code>) All'interno di note di rilascio ben dettagliate
|
||||
si possono aggiungere le note manualmente oppure è possibile
|
||||
@ -248,7 +237,7 @@ version: 1.0.0
|
||||
profondamente diversi.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} è una Ruby gem creata dal team
|
||||
#{link_to "Vandamme", data.links.vandamme} è una Ruby gem creata dal team
|
||||
Gemnasium ed è in grado di fare il parsing dei
|
||||
changelog di molti (ma non tutti) i progetti open source.
|
||||
|
||||
@ -299,11 +288,11 @@ version: 1.0.0
|
||||
la discussione sia importante almeno quanto il risultato finale.
|
||||
|
||||
%p
|
||||
Quindi per favore <strong>#{link_to "partecipate", gh}</strong>.
|
||||
Quindi per favore <strong>#{link_to "partecipate", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Dialogo
|
||||
%p
|
||||
Sono andato a #{link_to "The Changelog podcast", thechangelog}
|
||||
Sono andato a #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
per parlare del perché i gestori e i contributori dovrebbero preoccuparsi dei changelog
|
||||
e anche delle motivazioni dietro questo progetto.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Keep a Changelog
|
||||
language: ja
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 変更履歴を記録する
|
||||
%h2 友達にGitログを変更履歴に移させないでください。
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -73,7 +60,7 @@ version: 1.0.0
|
||||
%li
|
||||
各バージョンのリリース日を表示されます。
|
||||
%li
|
||||
#{link_to "Semantic Versioning", semver} に従っているかどうか言及してください。
|
||||
#{link_to "Semantic Versioning", data.links.semver} に従っているかどうか言及してください。
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types 変更の種類
|
||||
@ -160,11 +147,11 @@ version: 1.0.0
|
||||
地域の日付形式は世界中で異なり、誰にとっても直感的でヒューマンフレンドリーな日付形式を見つけるのは困難です。
|
||||
<code>2017-07-17</code> のように形式化された日付の利点は、年、月、日のように最大から最小の単位の順序に従うということです。
|
||||
この形式は、月と日の位置を切り替える地域の形式とは異なり、他の日付形式とあいまいに重なり合うこともありません。
|
||||
これらの理由、およびこの日付形式が #{link_to "ISO standard", iso} であるという事実が、それが変更履歴エントリに推奨される日付形式である理由です。
|
||||
これらの理由、およびこの日付形式が #{link_to "ISO standard", data.links.isodate} であるという事実が、それが変更履歴エントリに推奨される日付形式である理由です。
|
||||
|
||||
%aside
|
||||
これだけではありません。
|
||||
= link_to "Issueを開く", issues
|
||||
= link_to "Issueを開く", data.links.issue
|
||||
か、プルリクエストにてこれらのアンチパターンの収集を手伝ってください。
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -177,19 +164,19 @@ version: 1.0.0
|
||||
変更履歴の標準的な書式がありますか？
|
||||
|
||||
%p
|
||||
実はありません。 #{link_to "GNU changelog style guide", gnustyle} 、
|
||||
もしくは #{link_to "two-paragraph-long GNU NEWS file", gnunews} "guideline" があります。
|
||||
実はありません。 #{link_to "GNU changelog style guide", data.links.gnustyle} 、
|
||||
もしくは #{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews} "guideline" があります。
|
||||
どちらも不十分であり不適切です。
|
||||
|
||||
%p
|
||||
このプロジェクトは
|
||||
= link_to "より良い変更履歴の規約", changelog
|
||||
= link_to "より良い変更履歴の規約", data.links.changelog
|
||||
になることを目指しています。
|
||||
それはオープンソースコミュニティの良い習慣を観察し、それらを集めることから来ます。
|
||||
|
||||
%p
|
||||
健全な批判、議論、そして改善のための提案を
|
||||
= link_to "歓迎しています。", issues
|
||||
= link_to "歓迎しています。", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -209,7 +196,7 @@ version: 1.0.0
|
||||
GitHubリリースはどうですか？
|
||||
|
||||
%p
|
||||
素晴らしい主導権です。 #{link_to "Releases", ghr} は手動でリリースノートを追加することによって、
|
||||
素晴らしい主導権です。 #{link_to "Releases", data.links.github_releases} は手動でリリースノートを追加することによって、
|
||||
単純なGitタグ(例えば <code>v1.0.0</code> という名前のタグ)をリッチなリリースノートに変換するために使用することができます。
|
||||
|
||||
%p
|
||||
@ -229,7 +216,7 @@ version: 1.0.0
|
||||
人々は大きく異なるフォーマットやファイル名に従うので、難しいです。
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} はGemnasiumチームによって作成されたRuby gemであり、
|
||||
#{link_to "Vandamme", data.links.vandamme} はGemnasiumチームによって作成されたRuby gemであり、
|
||||
（全てではないが）多くのオープンソースプロジェクトの変更履歴を解析します。
|
||||
|
||||
|
||||
@ -277,10 +264,10 @@ version: 1.0.0
|
||||
私は議論が最終結果と同じくらい重要であると思います。
|
||||
|
||||
%p
|
||||
なので <strong>#{link_to "協力", gh}</strong> してください。
|
||||
なので <strong>#{link_to "協力", data.links.repo}</strong> してください。
|
||||
|
||||
.press
|
||||
%h3 座談
|
||||
%p
|
||||
私は #{link_to "The Changelog podcast", thechangelog} で、メンテナーやコントリビューターがなぜ変更履歴を気にすべきなのか、
|
||||
私は #{link_to "The Changelog podcast", data.links.thechangelog} で、メンテナーやコントリビューターがなぜ変更履歴を気にすべきなのか、
|
||||
そしてこのプロジェクトの背後にある動機について話しました。
|
||||
|
||||
@ -4,25 +4,12 @@ title: 変更履歴を記録する
|
||||
language: ja
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main//CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 変更履歴を記録する
|
||||
%h2 友達がGit記録を変更履歴に丸写しするのを止めさせよう。
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +64,7 @@ version: 1.1.0
|
||||
%li
|
||||
各版のリリース日を表示されます。
|
||||
%li
|
||||
#{link_to "Semantic Versioning", semver} に従っているかどうか言及してください。
|
||||
#{link_to "Semantic Versioning", data.links.semver} に従っているかどうか言及してください。
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types 変更の種類
|
||||
@ -167,7 +154,7 @@ version: 1.1.0
|
||||
年、月、日のように最大から最小の単位の順序に従うということです。
|
||||
この形式は、月と日の位置を切り替える地域の形式とは異なり、
|
||||
他の日付形式とあいまいに重なり合うこともありません。
|
||||
これらの理由、およびこの日付形式が #{link_to "国際標準", iso} であるという事実が、
|
||||
これらの理由、およびこの日付形式が #{link_to "国際標準", data.links.isodate} であるという事実が、
|
||||
それが変更履歴項目に推奨される日付形式である理由です。
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -187,7 +174,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
これだけではありません。
|
||||
= link_to "Issueを開く", issues
|
||||
= link_to "Issueを開く", data.links.issue
|
||||
か、プルリクエストして、こういった反面教師の収集を手伝ってください。
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -201,20 +188,20 @@ version: 1.1.0
|
||||
|
||||
%p
|
||||
実はありません。
|
||||
#{link_to "GNU changelog style guide", gnustyle} 、もしくは
|
||||
#{link_to "two-paragraph-long GNU NEWS file", gnunews} という
|
||||
#{link_to "GNU changelog style guide", data.links.gnustyle} 、もしくは
|
||||
#{link_to "two-paragraph-long GNU NEWS file", data.links.gnunews} という
|
||||
「指針」があります。
|
||||
しかしどちらも不十分であり不適切です。
|
||||
|
||||
%p
|
||||
この事業は
|
||||
= link_to "より良い変更履歴の規約", changelog
|
||||
= link_to "より良い変更履歴の規約", data.links.changelog
|
||||
になることを目指しています。
|
||||
それはオープンソース団体の良い習慣を観察し、それらを集めることから来ます。
|
||||
|
||||
%p
|
||||
健全な批判、議論、そして改善のための提案を
|
||||
= link_to "歓迎しています。", issues
|
||||
= link_to "歓迎しています。", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -235,7 +222,7 @@ version: 1.1.0
|
||||
GitHubリリースはどうですか？
|
||||
|
||||
%p
|
||||
極めて先駆的です。 #{link_to "Releases", ghr} に手動でリリース告知を追加することによって、
|
||||
極めて先駆的です。 #{link_to "Releases", data.links.github_releases} に手動でリリース告知を追加することによって、
|
||||
単純なGitタグ（例えば <code>v1.0.0</code> という名前の標識）を素敵なリリース告知に変換するために使用できます。
|
||||
|
||||
%p
|
||||
@ -257,7 +244,7 @@ version: 1.1.0
|
||||
人々によって形式やファイル名は大きく異なるため、難しいです。
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} はGemnasiumチームが作成したRuby gemであり、
|
||||
#{link_to "Vandamme", data.links.vandamme} はGemnasiumチームが作成したRuby gemであり、
|
||||
（全てではありませんが）多くのオープンソース事業の変更履歴を解析できます。
|
||||
|
||||
|
||||
@ -305,11 +292,11 @@ version: 1.1.0
|
||||
私は議論が最終結果と同じくらい重要であると思います。
|
||||
|
||||
%p
|
||||
なので <strong>#{link_to "協力", gh}</strong> してください。
|
||||
なので <strong>#{link_to "協力", data.links.repo}</strong> してください。
|
||||
|
||||
.press
|
||||
%h3 座談
|
||||
%p
|
||||
私は #{link_to "The Changelog podcast", thechangelog} で、
|
||||
私は #{link_to "The Changelog podcast", data.links.thechangelog} で、
|
||||
管理者や貢献者がなぜ変更履歴を気にすべきなのか、
|
||||
そしてこの事業の背後にある動機について話しました。
|
||||
|
||||
@ -4,25 +4,12 @@ title: შეინარჩუნე ცვლილებების ჟუ
|
||||
language: en
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 შეინარჩუნე ცვლილებების ჟურნალი
|
||||
%h2 არ მისცე უფლება მეგობრებს git ჩანაწერები ჩაწერონ ცვლილებების ჟურნალში
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -76,7 +63,7 @@ version: 1.0.0
|
||||
%li
|
||||
გამოშვების თარიღი უნდა ეწეროს თითოეულ ვერსიას.
|
||||
%li
|
||||
ახსენე თუ იყენებ #{link_to "სემანტიკურ ვერსიონირებას", semver}.
|
||||
ახსენე თუ იყენებ #{link_to "სემანტიკურ ვერსიონირებას", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types ცვლილებების ტიპი
|
||||
@ -166,12 +153,12 @@ version: 1.0.0
|
||||
წელი, თვე და დღე. ეს ფორმატი ასევე არ ემთხვევა სხვა თარიღის ფორმატებს უცნაური ვარიანტებით,
|
||||
განსხვავებით სხვა ფორმატებისგან რომლებიც ზოგჯერ ცვლიან დღის და თვის რიცხვების პოზიციას.
|
||||
ამ მიზეზთან გამო და იმის გამო, რომ ეს ფორმატი
|
||||
#{link_to "ISO სტანდარტია", iso}, იგი რეკომენდირებული თარიღის ფორმატია
|
||||
#{link_to "ISO სტანდარტია", data.links.isodate}, იგი რეკომენდირებული თარიღის ფორმატია
|
||||
ცვლილებების ჟურნალის ჩანაწერებისთვის.
|
||||
|
||||
%aside
|
||||
დამეხმარე სხვა არაზუსტი შაბლონების შეგროვებაში
|
||||
= link_to "ახალი საკითხის გახსნით", issues
|
||||
= link_to "ახალი საკითხის გახსნით", data.links.issue
|
||||
ან pull მოთხოვნით.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -184,18 +171,18 @@ version: 1.0.0
|
||||
არის თუ არა რაიმე სტანდარტული ფორმატი ცვლილებების ჟურნალისთვის?
|
||||
|
||||
%p
|
||||
არა. არსებობს #{link_to "GNU ცვლილებების ჟურნალის სტილი", gnustyle},
|
||||
ან #{link_to "2 პარაგრაფის სიგრძის GNU NEWS ფაილი", gnunews}
|
||||
არა. არსებობს #{link_to "GNU ცვლილებების ჟურნალის სტილი", data.links.gnustyle},
|
||||
ან #{link_to "2 პარაგრაფის სიგრძის GNU NEWS ფაილი", data.links.gnunews}
|
||||
"დირექტივა". ორივე შეუფერებელი და არასაკმარისია.
|
||||
|
||||
%p
|
||||
პროექტის მიზანია
|
||||
= link_to "ჩამოაყალიბოს უკეთესი კონვენცია ცვლილებების ჟურნალისთვის.", changelog
|
||||
= link_to "ჩამოაყალიბოს უკეთესი კონვენცია ცვლილებების ჟურნალისთვის.", data.links.changelog
|
||||
რომელიც შედეგია წარმატებულ გამოცდილებებზე დაკვირვების ჩვენს კომუნაში და შემდგომ ერთად თავმოყრის.
|
||||
|
||||
%p
|
||||
ჯანსაღი კრიტიკა, დისკუსია და გაუმჯობესების რჩევები
|
||||
= link_to "მისასალმებელია.", issues
|
||||
= link_to "მისასალმებელია.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -215,7 +202,7 @@ version: 1.0.0
|
||||
რა ხდება GitHub Releases დროს?
|
||||
|
||||
%p
|
||||
შესანიშნავი ინიციატივაა. #{link_to "Releases", ghr} შესაძლებელია გამოყენებულ იქნას როგორც,
|
||||
შესანიშნავი ინიციატივაა. #{link_to "Releases", data.links.github_releases} შესაძლებელია გამოყენებულ იქნას როგორც,
|
||||
უბრალო git იარლიყების(tag) (მაგალითად იარლიყი სახელად <code>v1.0.0</code>)
|
||||
გადასაქცევად სრულყოფილ გამოშვების ჩანაწერებად ჩვენს მიერ
|
||||
ან შესაძლებელია git იარლიყების შეტყობინების ავტომატურად წამოღება და ჩანაწერად ქცევა.
|
||||
@ -238,7 +225,7 @@ version: 1.0.0
|
||||
რთულია, რადგან ხალხი იყენებს რადიკალურად განსხვავებულ ფორმატებს და ფაილის სახელებს.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} არის Ruby gem შექმნილი
|
||||
#{link_to "Vandamme", data.links.vandamme} არის Ruby gem შექმნილი
|
||||
Gemnasium გუნდის მიერ რომელიც აანალიზებს უმრავლეს (თუმცა
|
||||
ყველას არა) ,ღია პროექტის, ცვლილებების ჟურნალს.
|
||||
|
||||
@ -287,11 +274,11 @@ version: 1.0.0
|
||||
|
||||
|
||||
%p
|
||||
ასე რომ გთხოვ <strong>#{link_to "ჩაერთე", gh}</strong>.
|
||||
ასე რომ გთხოვ <strong>#{link_to "ჩაერთე", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 საუბრები
|
||||
%p
|
||||
ვიყავი #{link_to "The Changelog პოდკასტის", thechangelog} სტუმარი და ვისაუბრე
|
||||
ვიყავი #{link_to "The Changelog პოდკასტის", data.links.thechangelog} სტუმარი და ვისაუბრე
|
||||
რატომ უნდა იზრუნონ ცვლილებების ჟურნალზე კონტრიბუტორებმა და ისინი ვინც კოდს ინარჩუნებენ ყველაზე მეტად.
|
||||
ამავდროულად მოტივაციაზე ამ პროექტის უკან.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Keep a Changelog
|
||||
language: ko
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Changelog 관리
|
||||
%h2 동료가 git 로그를 changelogs에 덤프하게 내버려 두지 마세요.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -72,7 +61,7 @@ version: 1.0.0
|
||||
%li
|
||||
각 버전의 릴리즈 날짜를 표시해야 합니다.
|
||||
%li
|
||||
#{link_to "시멘틱 버저닝", semver}를 따르는지 언급해 주세요.
|
||||
#{link_to "시멘틱 버저닝", data.links.semver}를 따르는지 언급해 주세요.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types 변경 유형
|
||||
@ -160,12 +149,12 @@ version: 1.0.0
|
||||
<code>2017-07-17</code> 같은 날짜 포맷(연, 월, 일)의 장점은
|
||||
큰 단위부터 작은 단위의 순서를 따른다는 것입니다.
|
||||
월과 일의 위치가 뒤바뀐 어떤 포맷과 다르게, 이 포맷은 다른 날짜 포맷과 모호하게 겹치는 부분이 없습니다.
|
||||
이런 이유와 이 포맷이 #{link_to "ISO standard", iso}라는 사실이
|
||||
이런 이유와 이 포맷이 #{link_to "ISO standard", data.links.isodate}라는 사실이
|
||||
changelog 기입을 위해 이 날짜 포맷을 추천하는 이유입니다.
|
||||
|
||||
%aside
|
||||
안티패턴은 더 있습니다.
|
||||
= link_to "이슈 오픈하기", issues
|
||||
= link_to "이슈 오픈하기", data.links.issue
|
||||
나 pull 요청을 통해
|
||||
안티패턴들을 모으는 것을 도와주세요.
|
||||
|
||||
@ -184,13 +173,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
이 프로젝트의 목표는
|
||||
= link_to "더 나은 changelog 규칙", changelog
|
||||
= link_to "더 나은 changelog 규칙", data.links.changelog
|
||||
입니다.
|
||||
이것은 오픈소스 커뮤니티에서 좋은 용례를 관찰하고 모으는데서 나옵니다.
|
||||
|
||||
%p
|
||||
건강한 비판, 토론 및 개선 제안은
|
||||
= link_to "환영합니다.", issues
|
||||
= link_to "환영합니다.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -210,7 +199,7 @@ version: 1.0.0
|
||||
깃허브 릴리즈는 어떻게 하나요?
|
||||
|
||||
%p
|
||||
이것은 훌륭한 이니셔티브입니다. #{link_to "릴리즈", ghr}는
|
||||
이것은 훌륭한 이니셔티브입니다. #{link_to "릴리즈", data.links.github_releases}는
|
||||
직접 릴리즈 노트를 추가하거나 어노테이션된 깃 태그 메시지를 가져와서 노트로 바꿔
|
||||
간단한 깃 태그(예를 들어 <code>v1.0.0</code> 태그
|
||||
)를 풍부한 릴리즈 노트로 전환시키는데 사용될 수 있습니다.
|
||||
@ -232,7 +221,7 @@ version: 1.0.0
|
||||
사람들이 대단히 다양한 포맷과 파일 이름을 따르기 때문에 어렵습니다.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme}은 Gemnasium 팀에 의해
|
||||
#{link_to "Vandamme", data.links.vandamme}은 Gemnasium 팀에 의해
|
||||
생성된 루비잼이고 많은(전부는 아니고) 오픈소스 프로젝트의 changelog를 파싱합니다.
|
||||
|
||||
|
||||
@ -277,10 +266,10 @@ version: 1.0.0
|
||||
왜냐하면 우리 커뮤니티가 공감대를 형성하기를 원하기 때문입니다. 저는 최종결과 못지않게 토론도 중요하다고 생각합니다.
|
||||
|
||||
%p
|
||||
그러니 <strong>#{link_to "참여", gh}</strong>를 부탁합니다.
|
||||
그러니 <strong>#{link_to "참여", data.links.repo}</strong>를 부탁합니다.
|
||||
|
||||
.press
|
||||
%h3 대화
|
||||
%p
|
||||
왜 관리자와 기여자가 changelog를 신경써야하는지, 또한 이 프로젝트를 하게된 동기에 대해 이야기하기 위해
|
||||
#{link_to "The Changelog 팟캐스트", thechangelog}에 다녀왔습니다.
|
||||
#{link_to "The Changelog 팟캐스트", data.links.thechangelog}에 다녀왔습니다.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Lag en Endringslogg
|
||||
language: nb
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main//CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Lag en Endringslogg
|
||||
%h2 Ikke la vennene dine dumpe git logger i endringslogger.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versjon
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.1.0
|
||||
%li
|
||||
Utgivelsesdatoen for hver versjon vises.
|
||||
%li
|
||||
Nevn hvorvidt du følger #{link_to "Semantisk Versjonering", semver}.
|
||||
Nevn hvorvidt du følger #{link_to "Semantisk Versjonering", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Type endringer
|
||||
@ -175,7 +162,7 @@ version: 1.1.0
|
||||
Dette formatet overlapper heller ikke på tvetydige måter, til
|
||||
forskjell fra noen regionale formater som bytter posisjonen til
|
||||
måneds- og datonumre. Derfor, og fordi dette datoformatet er en
|
||||
#{link_to "ISO-standard", iso}, er det anbefalt datoformat for
|
||||
#{link_to "ISO-standard", data.links.isodate}, er det anbefalt datoformat for
|
||||
oppføringer i endringslogger.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -195,7 +182,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
Det er mer. Hjelp meg med å samle disse antimønstrene ved å
|
||||
= link_to "åpne en sak", issues
|
||||
= link_to "åpne en sak", data.links.issue
|
||||
saker eller et endringsforslag.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -208,19 +195,19 @@ version: 1.1.0
|
||||
Er det et standard format for endringslogger?
|
||||
|
||||
%p
|
||||
Ikke egentlig. Det finnes #{link_to "GNUs stilguide for endringslogger", gnustyle},
|
||||
eller den #{link_to "to avsnitt lange GNU NEWS filen", gnunews}
|
||||
Ikke egentlig. Det finnes #{link_to "GNUs stilguide for endringslogger", data.links.gnustyle},
|
||||
eller den #{link_to "to avsnitt lange GNU NEWS filen", data.links.gnunews}
|
||||
"retningslinjen". Begge er inadekvate eller utilstrekkelige.
|
||||
|
||||
%p
|
||||
Dette prosjektet søker å være
|
||||
= link_to "en bedre konvensjon for endringslogger", changelog
|
||||
= link_to "en bedre konvensjon for endringslogger", data.links.changelog
|
||||
Dette kommer fra observasjon av beste praksis i miljøet
|
||||
for åpen kildekode og innsamling av de.
|
||||
|
||||
%p
|
||||
Sunn kritikk, diskusjon og forslag til forbedringer
|
||||
= link_to "er velkomne.", issues
|
||||
= link_to "er velkomne.", data.links.issue
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -240,7 +227,7 @@ version: 1.1.0
|
||||
Hva med utgivelser på GitHub?
|
||||
|
||||
%p
|
||||
Det er et flott initiativ. #{link_to "Utgivelser", ghr} kan brukes
|
||||
Det er et flott initiativ. #{link_to "Utgivelser", data.links.github_releases} kan brukes
|
||||
for å gjøre enkle taggede versjoner på git (for eksempel <code>v1.0.0</code>)
|
||||
om til fyldige utgivelsesnotater ved å manuelt legge de til, eller
|
||||
å hente annoterte notater fra taggede versjoner å gjøre de om til
|
||||
@ -269,7 +256,7 @@ version: 1.1.0
|
||||
og filnavn.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} er en Ruby gem laget av Gemnasium-teamet
|
||||
#{link_to "Vandamme", data.links.vandamme} er en Ruby gem laget av Gemnasium-teamet
|
||||
for å tolke mange (men ikke alle) endringslogger for prosjekter med
|
||||
åpen kildekode.
|
||||
|
||||
@ -318,11 +305,11 @@ version: 1.1.0
|
||||
at diskusjonen er like viktig som resultatet.
|
||||
|
||||
%p
|
||||
Så vær så snill, <strong>#{link_to "bidra", gh}</strong>.
|
||||
Så vær så snill, <strong>#{link_to "bidra", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Samtaler
|
||||
%p
|
||||
Jeg deltok på #{link_to "The Changelog podcast", thechangelog} for
|
||||
Jeg deltok på #{link_to "The Changelog podcast", data.links.thechangelog} for
|
||||
å snakke om hvorfor vedlikeholdere og bidragsytere burde bry seg om
|
||||
endringslogger, og også om motivasjonene bak dette prosjektet.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Keep a Changelog
|
||||
language: nl
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Houd een Changelog bij
|
||||
%h2 Laat je vrienden geen git logs in changelogs dumpen.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versie
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -75,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
De release datum van elke versie word weergegeven.
|
||||
%li
|
||||
Geef aan of je #{link_to "Semantic Versioning", semver} gebruikt.
|
||||
Geef aan of je #{link_to "Semantic Versioning", data.links.semver} gebruikt.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types of changes
|
||||
@ -165,12 +154,12 @@ version: 1.0.0
|
||||
een notatie te vinden die makkelijk te lezen is en intuïtief is voor iedereen.
|
||||
|
||||
Het voordeel van de notatie <code>2017-07-17</code> is dat het jaar, maand en dag
|
||||
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", iso}
|
||||
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", data.links.isodate}
|
||||
is, is dit de aanbevolen datum notatie voor changelog releases.
|
||||
|
||||
%aside
|
||||
Dit is niet alles. Help mij antipatterns te verzamelen door
|
||||
= link_to "een issue", issues
|
||||
= link_to "een issue", data.links.issue
|
||||
of een pull request aan te maken.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -188,12 +177,12 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Dit project poogt
|
||||
= link_to "een betere changelog standaard", changelog
|
||||
= link_to "een betere changelog standaard", data.links.changelog
|
||||
te creëren. Dit op basis van "good practices" uit de open source wereld.
|
||||
|
||||
%p
|
||||
Opbouwende kritiek, discussie en suggesties voor verbetering
|
||||
= link_to "zijn welkom.", issues
|
||||
= link_to "zijn welkom.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -213,7 +202,7 @@ version: 1.0.0
|
||||
Wat denk je van GitHub Releases?
|
||||
|
||||
%p
|
||||
Het is een goed initiatief. #{link_to "Releases", ghr} kan gebruikt worden
|
||||
Het is een goed initiatief. #{link_to "Releases", data.links.github_releases} kan gebruikt worden
|
||||
om simpele git tags (bijvoorbeeld een tag met de naam <code>v1.0.0</code>)
|
||||
te veranderen in uitgebreide release notes door deze handmatig toe te voegen of
|
||||
door geannoteerde git tag berichten te gebruiken om release notes te genereren.
|
||||
@ -239,7 +228,7 @@ version: 1.0.0
|
||||
Dat is lastig, mensen gebruiken immers veel verschillende formats en bestandsnamen.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} is een Ruby gem van het
|
||||
#{link_to "Vandamme", data.links.vandamme} is een Ruby gem van het
|
||||
Gemnasium team wat de changelogs van veel (maar niet alle)
|
||||
open source projecten kan parsen.
|
||||
|
||||
@ -288,10 +277,10 @@ version: 1.0.0
|
||||
Ik denk dat de discussie net zo belangrijk is als het eindresultaat.
|
||||
|
||||
%p
|
||||
Dus <strong>#{link_to "alle hulp is welkom", gh}</strong>.
|
||||
Dus <strong>#{link_to "alle hulp is welkom", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversaties
|
||||
%p
|
||||
Ik was te gast bij #{link_to "The Changelog podcast", thechangelog} om te praten over
|
||||
Ik was te gast bij #{link_to "The Changelog podcast", data.links.thechangelog} om te praten over
|
||||
waarom een changelog belangrijk is programmeurs, en over mijn motivatie achter dit project.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Keep a Changelog
|
||||
language: nl
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main//CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Houd een Changelog bij
|
||||
%h2 Laat je vrienden geen git logs in changelogs dumpen.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Versie
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -75,7 +64,7 @@ version: 1.1.0
|
||||
%li
|
||||
De release datum van elke versie word weergegeven.
|
||||
%li
|
||||
Geef aan of je #{link_to "Semantic Versioning", semver} gebruikt.
|
||||
Geef aan of je #{link_to "Semantic Versioning", data.links.semver} gebruikt.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types of changes
|
||||
@ -165,7 +154,7 @@ version: 1.1.0
|
||||
een notatie te vinden die makkelijk te lezen is en intuïtief is voor iedereen.
|
||||
|
||||
Het voordeel van de notatie <code>2017-07-17</code> is dat het jaar, maand en dag
|
||||
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", iso}
|
||||
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", data.links.isodate}
|
||||
is, is dit de aanbevolen datum notatie voor changelog releases.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -185,7 +174,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
Dit is niet alles. Help mij antipatterns te verzamelen door
|
||||
= link_to "een issue", issues
|
||||
= link_to "een issue", data.links.issue
|
||||
of een pull request aan te maken.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -203,12 +192,12 @@ version: 1.1.0
|
||||
|
||||
%p
|
||||
Dit project poogt
|
||||
= link_to "een betere changelog standaard", changelog
|
||||
= link_to "een betere changelog standaard", data.links.changelog
|
||||
te creëren. Dit op basis van "good practices" uit de open source wereld.
|
||||
|
||||
%p
|
||||
Opbouwende kritiek, discussie en suggesties voor verbetering
|
||||
= link_to "zijn welkom.", issues
|
||||
= link_to "zijn welkom.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -228,7 +217,7 @@ version: 1.1.0
|
||||
Wat denk je van GitHub Releases?
|
||||
|
||||
%p
|
||||
Het is een goed initiatief. #{link_to "Releases", ghr} kan gebruikt worden
|
||||
Het is een goed initiatief. #{link_to "Releases", data.links.github_releases} kan gebruikt worden
|
||||
om simpele git tags (bijvoorbeeld een tag met de naam <code>v1.0.0</code>)
|
||||
te veranderen in uitgebreide release notes door deze handmatig toe te voegen of
|
||||
door geannoteerde git tag berichten te gebruiken om release notes te genereren.
|
||||
@ -254,7 +243,7 @@ version: 1.1.0
|
||||
Dat is lastig, mensen gebruiken immers veel verschillende formats en bestandsnamen.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} is een Ruby gem van het
|
||||
#{link_to "Vandamme", data.links.vandamme} is een Ruby gem van het
|
||||
Gemnasium team wat de changelogs van veel (maar niet alle)
|
||||
open source projecten kan parsen.
|
||||
|
||||
@ -303,10 +292,10 @@ version: 1.1.0
|
||||
Ik denk dat de discussie net zo belangrijk is als het eindresultaat.
|
||||
|
||||
%p
|
||||
Dus <strong>#{link_to "alle hulp is welkom", gh}</strong>.
|
||||
Dus <strong>#{link_to "alle hulp is welkom", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversaties
|
||||
%p
|
||||
Ik was te gast bij #{link_to "The Changelog podcast", thechangelog} om te praten over
|
||||
Ik was te gast bij #{link_to "The Changelog podcast", data.links.thechangelog} om te praten over
|
||||
waarom een changelog belangrijk is programmeurs, en over mijn motivatie achter dit project.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Prowadź Changelog
|
||||
language: pl
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Prowadź Changelog
|
||||
%h2 Nie pozwól swoim znajomym wklejać logów Gita do changelogów.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Wersja
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -74,7 +63,7 @@ version: 1.0.0
|
||||
%li
|
||||
Wyszczególniona data wydania każdej wersji.
|
||||
%li
|
||||
Wzmianka, czy przestrzegacie #{link_to "wersjonowania semantycznego", semver}.
|
||||
Wzmianka, czy przestrzegacie #{link_to "wersjonowania semantycznego", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Typy zmian
|
||||
@ -170,12 +159,12 @@ version: 1.0.0
|
||||
i dnia. Ten format również nie nachodzi w niejednoznaczny sposób na inne
|
||||
formaty dat, w przeciwieństwie do niektórych regionalnych formatów, które
|
||||
zamieniają miejsce numerów miesiąca i dnia. Z tych powodów i faktu, że
|
||||
ten format daty jest #{link_to "standardem ISO", iso}, wynika rekomendacja
|
||||
ten format daty jest #{link_to "standardem ISO", data.links.isodate}, wynika rekomendacja
|
||||
tego formatu daty do wpisów w changelogu.
|
||||
|
||||
%aside
|
||||
Jest tego więcej. Pomóż mi zebrać te antywzorce
|
||||
= link_to "otwierając zgłoszenie", issues
|
||||
= link_to "otwierając zgłoszenie", data.links.issue
|
||||
lub pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -193,13 +182,13 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Ten projekt pretenduje do bycia
|
||||
= link_to "lepszą konwencją changelogu.", changelog
|
||||
= link_to "lepszą konwencją changelogu.", data.links.changelog
|
||||
Pochodzi z obserwowania i zebrania dobrych praktyk w społeczności open
|
||||
source.
|
||||
|
||||
%p
|
||||
Zdrowa krytyka, dyskusja i sugestie poprawek
|
||||
= link_to "są mile widziane.", issues
|
||||
= link_to "są mile widziane.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -220,7 +209,7 @@ version: 1.0.0
|
||||
Co z GitHub Releases?
|
||||
|
||||
%p
|
||||
To wspaniała inicjatywa. #{link_to "Releases", ghr} mogą być używane do
|
||||
To wspaniała inicjatywa. #{link_to "Releases", data.links.github_releases} mogą być używane do
|
||||
zmiany prostych tagów Gita (na przykład taga nazwanego <code>v1.0.0</code>)
|
||||
w bogate informacje o wydaniach przez ręczne dodanie informacji lub mogą
|
||||
wyciągać oznaczone message tagów i przekształcać je w informacje.
|
||||
@ -245,7 +234,7 @@ version: 1.0.0
|
||||
To trudne, ponieważ ludzie stosują bardzo różne formaty i nazwy plików.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} jest gemem Ruby stworzonym przez zespół
|
||||
#{link_to "Vandamme", data.links.vandamme} jest gemem Ruby stworzonym przez zespół
|
||||
Gemnasium i który parsuje wiele (ale nie wszystkie)
|
||||
changelogów projektów open source.
|
||||
|
||||
@ -295,11 +284,11 @@ version: 1.0.0
|
||||
dyskusja jest tak samo istotna jak efekt końcowy.
|
||||
|
||||
%p
|
||||
Więc proszę, <strong>#{link_to "wtrąć się", gh}</strong>.
|
||||
Więc proszę, <strong>#{link_to "wtrąć się", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Rozmowy
|
||||
%p
|
||||
Byłem na #{link_to "podcaście Changelog", thechangelog}, aby porozmawiać
|
||||
Byłem na #{link_to "podcaście Changelog", data.links.thechangelog}, aby porozmawiać
|
||||
dlaczego opiekunowie i kontrybutorzy powinni dbać o changelogi, a także
|
||||
o motywacjach stojących za tym projektem.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Mantenha um Changelog
|
||||
language: pt-BR
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Mantenha um Changelog
|
||||
%h2 Não deixe seus amigos despejarem logs de commits no Changelog
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +66,7 @@ version: 1.0.0
|
||||
%li
|
||||
A data de lançamento de cada versão é exibida.
|
||||
%li
|
||||
Mencione se você segue o #{link_to "versionamento semântico", semver}.
|
||||
Mencione se você segue o #{link_to "versionamento semântico", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Tipos de mudanças
|
||||
@ -172,12 +161,12 @@ version: 1.0.0
|
||||
também não se confunde de maneira ambígua com outros formatos de data, ao
|
||||
contrário de alguns formatos regionais que alteram a posição dos números do mês
|
||||
e dia. Esses motivos, e o fato de ser um formato de data suportado pela
|
||||
#{link_to "norma ISO", iso} são as razões para ele ser o formato de data
|
||||
#{link_to "norma ISO", data.links.isodate} são as razões para ele ser o formato de data
|
||||
recomendado para as entradas do changelog.
|
||||
|
||||
%aside
|
||||
Tem mais. Me ajude a colecionar essas más práticas
|
||||
= link_to "enviando uma dúvida", issues
|
||||
= link_to "enviando uma dúvida", data.links.issue
|
||||
ou pedindo mudanças.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -195,13 +184,13 @@ version: 1.0.0
|
||||
insuficientes.
|
||||
|
||||
%p
|
||||
Este projeto pretende ser #{link_to "uma convenção de changelog melhor.", changelog}
|
||||
Este projeto pretende ser #{link_to "uma convenção de changelog melhor.", data.links.changelog}
|
||||
Ele vem de observar e coletar as boas práticas em código aberto da
|
||||
comunidade.
|
||||
|
||||
%p
|
||||
Críticas saudáveis, discussões e sugestões de melhorias
|
||||
= link_to "são bem-vindas.", issues
|
||||
= link_to "são bem-vindas.", data.links.issue
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -221,7 +210,7 @@ version: 1.0.0
|
||||
E sobre o GitHub Releases?
|
||||
|
||||
%p
|
||||
É uma grande iniciativa. #{link_to "Lançamentos", ghr} podem ser usados
|
||||
É uma grande iniciativa. #{link_to "Lançamentos", data.links.github_releases} podem ser usados
|
||||
para converter simples marcadores do git (por exemplo, um
|
||||
marcador chamado <code>v1.0.0</code>) em notas de versão ricas,
|
||||
adicionando manualmente notas de versão ou pode puxar as mensagens
|
||||
@ -249,7 +238,7 @@ version: 1.0.0
|
||||
totalmente diferentes.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} é um gem Ruby criado pelo
|
||||
#{link_to "Vandamme", data.links.vandamme} é um gem Ruby criado pelo
|
||||
time Gemnasium e que analisa muitas
|
||||
(mas não todas) alterações de projetos de código aberto.
|
||||
|
||||
@ -299,12 +288,12 @@ version: 1.0.0
|
||||
Eu acredito que a discussão é tão importante quanto o resultado final.
|
||||
|
||||
%p
|
||||
Então, por favor <strong>#{link_to "contribua", gh}</strong>.
|
||||
Então, por favor <strong>#{link_to "contribua", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Discussões
|
||||
%p
|
||||
Eu fui no #{link_to "The Changelog podcast", thechangelog}
|
||||
Eu fui no #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
para falar sobre por que os mantenedores e contribuidores devem se
|
||||
preocupar com os changelogs, e também sobre as motivações
|
||||
por trás desse projeto.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Keep a Changelog
|
||||
language: ru
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Ведите changelog
|
||||
%h2 Не позволяйте своим друзьям сливать логи Git в changelog’и.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
Указаны даты выпуска каждой версии.
|
||||
%li
|
||||
Уточните, следуете ли вы принципам #{link_to "семантического версионирования", semver}.
|
||||
Уточните, следуете ли вы принципам #{link_to "семантического версионирования", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Типы изменений
|
||||
@ -176,7 +163,7 @@ version: 1.0.0
|
||||
региональных форматов, в которых изменено положение чисел, обозначающих день
|
||||
и месяц, этот формат не пересекается с другим и не вызывает неоднозначных
|
||||
толкований. Исходя из этих причин и того факта, что этот формат соответствует
|
||||
#{link_to "стандарту ISO", iso}, именно он рекомендован для записей в логе
|
||||
#{link_to "стандарту ISO", data.links.isodate}, именно он рекомендован для записей в логе
|
||||
изменений.
|
||||
|
||||
%aside
|
||||
@ -194,19 +181,19 @@ version: 1.0.0
|
||||
Существует ли стандартный формат для логов изменений?
|
||||
|
||||
%p
|
||||
На самом деле, нет. Есть #{link_to "стилистический путеводитель по логам изменений от GNU", gnustyle},
|
||||
есть #{link_to "«руководство» длиной в два абзаца по файлам GNU NEWS", gnunews}.
|
||||
На самом деле, нет. Есть #{link_to "стилистический путеводитель по логам изменений от GNU", data.links.gnustyle},
|
||||
есть #{link_to "«руководство» длиной в два абзаца по файлам GNU NEWS", data.links.gnunews}.
|
||||
Оба или неадекватны, или недостаточно полны.
|
||||
|
||||
%p
|
||||
Этот проект нацелен на то, чтобы стать
|
||||
#{link_to "улучшенной версией соглашения о формате логов изменений", changelog}.
|
||||
#{link_to "улучшенной версией соглашения о формате логов изменений", data.links.changelog}.
|
||||
Проект опирается на отслеживание и накопление передового опыта сообщества
|
||||
пользователей открытого исходного кода.
|
||||
|
||||
%p
|
||||
Здоровая критика, дискуссии и предложения по улучшению
|
||||
#{link_to "приветствуются", issues}.
|
||||
#{link_to "приветствуются", data.links.issue}.
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -227,7 +214,7 @@ version: 1.0.0
|
||||
Что насчёт функции «Релизы» на GitHub’е?
|
||||
|
||||
%p
|
||||
Это отличная инициатива. #{link_to "Релизы", ghr} можно использовать
|
||||
Это отличная инициатива. #{link_to "Релизы", data.links.github_releases} можно использовать
|
||||
для превращения простых тегов Git (например, тега, названного <code>v1.0.0</code>)
|
||||
в подробные примечания к выпускам, вручную добавляя эти примечания, или же
|
||||
можно извлечь сообщения из аннотированных тегов Git и превратить их в примечания.
|
||||
@ -254,7 +241,7 @@ version: 1.0.0
|
||||
и используют разные имена файлов.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} — это gem для Ruby, созданный командой
|
||||
#{link_to "Vandamme", data.links.vandamme} — это gem для Ruby, созданный командой
|
||||
Gemnasium и способный парсить логи изменений во многих (но не всех)
|
||||
проектах с открытым исходным кодом.
|
||||
|
||||
@ -305,11 +292,11 @@ version: 1.0.0
|
||||
Я верю, что дискуссия так же важна, как и конечный результат.
|
||||
|
||||
%p
|
||||
Так что, пожалуйста, <strong>#{link_to "участвуйте", gh}</strong>.
|
||||
Так что, пожалуйста, <strong>#{link_to "участвуйте", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Обсуждения
|
||||
%p
|
||||
Я приходил на #{link_to "подкаст The Changelog", thechangelog}, чтобы поговорить о том,
|
||||
Я приходил на #{link_to "подкаст The Changelog", data.links.thechangelog}, чтобы поговорить о том,
|
||||
почему maintainer’ам (персоналу сопровождения) и контрибуторам следует озаботиться
|
||||
ведением логов изменений, а также о мотивах, стоящих за этим проектом.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Keep a Changelog
|
||||
language: ru
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Ведите changelog
|
||||
%h2 Не позволяйте своим друзьям сливать логи Git в changelog’и.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.1.0
|
||||
%li
|
||||
Указаны даты выпуска каждой версии.
|
||||
%li
|
||||
Уточните, следуете ли вы принципам #{link_to "семантического версионирования", semver}.
|
||||
Уточните, следуете ли вы принципам #{link_to "семантического версионирования", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Типы изменений
|
||||
@ -176,7 +163,7 @@ version: 1.1.0
|
||||
региональных форматов, в которых изменено положение чисел, обозначающих день
|
||||
и месяц, этот формат не пересекается с другим и не вызывает неоднозначных
|
||||
толкований. Исходя из этих причин и того факта, что этот формат соответствует
|
||||
#{link_to "стандарту ISO", iso}, именно он рекомендован для записей в логе
|
||||
#{link_to "стандарту ISO", data.links.isodate}, именно он рекомендован для записей в логе
|
||||
изменений.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -208,19 +195,19 @@ version: 1.1.0
|
||||
Существует ли стандартный формат для логов изменений?
|
||||
|
||||
%p
|
||||
На самом деле, нет. Есть #{link_to "стилистический путеводитель по логам изменений от GNU", gnustyle},
|
||||
есть #{link_to "«руководство» длиной в два абзаца по файлам GNU NEWS", gnunews}.
|
||||
На самом деле, нет. Есть #{link_to "стилистический путеводитель по логам изменений от GNU", data.links.gnustyle},
|
||||
есть #{link_to "«руководство» длиной в два абзаца по файлам GNU NEWS", data.links.gnunews}.
|
||||
Оба или неадекватны, или недостаточно полны.
|
||||
|
||||
%p
|
||||
Этот проект нацелен на то, чтобы стать
|
||||
#{link_to "улучшенной версией соглашения о формате логов изменений", changelog}.
|
||||
#{link_to "улучшенной версией соглашения о формате логов изменений", data.links.changelog}.
|
||||
Проект опирается на отслеживание и накопление передового опыта сообщества
|
||||
пользователей открытого исходного кода.
|
||||
|
||||
%p
|
||||
Здоровая критика, дискуссии и предложения по улучшению
|
||||
#{link_to "приветствуются", issues}.
|
||||
#{link_to "приветствуются", data.links.issue}.
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -241,7 +228,7 @@ version: 1.1.0
|
||||
Что насчёт функции «Релизы» на GitHub’е?
|
||||
|
||||
%p
|
||||
Это отличная инициатива. #{link_to "Релизы", ghr} можно использовать
|
||||
Это отличная инициатива. #{link_to "Релизы", data.links.github_releases} можно использовать
|
||||
для превращения простых тегов Git (например, тега, названного <code>v1.0.0</code>)
|
||||
в подробные примечания к выпускам, вручную добавляя эти примечания, или же
|
||||
можно извлечь сообщения из аннотированных тегов Git и превратить их в примечания.
|
||||
@ -268,7 +255,7 @@ version: 1.1.0
|
||||
и используют разные имена файлов.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} — это gem для Ruby, созданный командой
|
||||
#{link_to "Vandamme", data.links.vandamme} — это gem для Ruby, созданный командой
|
||||
Gemnasium и способный парсить логи изменений во многих (но не всех)
|
||||
проектах с открытым исходным кодом.
|
||||
|
||||
@ -319,11 +306,11 @@ version: 1.1.0
|
||||
Я верю, что дискуссия так же важна, как и конечный результат.
|
||||
|
||||
%p
|
||||
Так что, пожалуйста, <strong>#{link_to "участвуйте", gh}</strong>.
|
||||
Так что, пожалуйста, <strong>#{link_to "участвуйте", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Обсуждения
|
||||
%p
|
||||
Я приходил на #{link_to "подкаст The Changelog", thechangelog}, чтобы поговорить о том,
|
||||
Я приходил на #{link_to "подкаст The Changelog", data.links.thechangelog}, чтобы поговорить о том,
|
||||
почему maintainer’ам (персоналу сопровождения) и контрибуторам следует озаботиться
|
||||
ведением логов изменений, а также о мотивах, стоящих за этим проектом.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Udržuj changelog
|
||||
language: sk
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Udržuj changelog
|
||||
%h2 Nenechaj kamarátov sypať git logy do changelogov.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Verzia
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -75,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
Pre každú verziu je uvedený dátum jej vydania.
|
||||
%li
|
||||
Uveď tiež, že sa držíš #{link_to "sémantického verziovania", semver}.
|
||||
Uveď tiež, že sa držíš #{link_to "sémantického verziovania", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Typy zmien
|
||||
@ -168,12 +157,12 @@ version: 1.0.0
|
||||
používateľov. Výhodou dátumu vo formáte <code>2017-07-17</code> je poradie
|
||||
od najväčšej jednotky po najmenšiu: rok, mesiac, deň. Tento formát sa tiež
|
||||
neprekrýva s inými formátmi, ktoré zamieňajú pozíciu dňa a mesiaca. Kvôli
|
||||
týmto dôvodom spolu s faktom, že ide o #{link_to "ISO štandard", iso},
|
||||
týmto dôvodom spolu s faktom, že ide o #{link_to "ISO štandard", data.links.isodate},
|
||||
je tento formát odporučený pre záznamy v changelogu.
|
||||
|
||||
%aside
|
||||
Je toho však viac. Pomôž mi zozbierať tieto antivzory
|
||||
= link_to "otvorením issue", issues
|
||||
= link_to "otvorením issue", data.links.issue
|
||||
alebo pull requestom.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -191,12 +180,12 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Tento projekt sa snaží byť
|
||||
= link_to "lepšou konvenciou pre changelog.", changelog
|
||||
= link_to "lepšou konvenciou pre changelog.", data.links.changelog
|
||||
Vychádza z pozorovania a zozbierania osvedčených postupov komunity okolo projektov s otvoreným zdrojovým kódom.
|
||||
|
||||
%p
|
||||
Zdravá kritika, diskusia a návrhy na zlepšenie
|
||||
= link_to "sú vítané.", issues
|
||||
= link_to "sú vítané.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -216,7 +205,7 @@ version: 1.0.0
|
||||
A čo GitHub Releases?
|
||||
|
||||
%p
|
||||
Je to skvelá iniciatíva. Služba #{link_to "Releases", ghr} môže byť použitá
|
||||
Je to skvelá iniciatíva. Služba #{link_to "Releases", data.links.github_releases} môže byť použitá
|
||||
pre premenu git tagov (napríklad tagu <code>v1.0.0</code>) na bohaté
|
||||
poznámky k vydaniam manuálnym pridávaním týchto poznámok alebo získaním
|
||||
správ z anotovaných git tagov a vytvorením poznámok k vydaniu z nich.
|
||||
@ -242,7 +231,7 @@ version: 1.0.0
|
||||
Je to zložité, pretože ľudia používajú rôzne formáty a názvy súborov.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} je Ruby gem vytvorený tímom
|
||||
#{link_to "Vandamme", data.links.vandamme} je Ruby gem vytvorený tímom
|
||||
Gemnasium, ktorý parsuje mnohé (ale nie všetky)
|
||||
changelogy projektov s otvoreným zdrojovým kódom.
|
||||
|
||||
@ -292,11 +281,11 @@ version: 1.0.0
|
||||
diskusia je rovnako dôležitá ako samotný výsledok.
|
||||
|
||||
%p
|
||||
Takže, prosím, <strong>#{link_to "prilož ruku k dielu", gh}</strong>.
|
||||
Takže, prosím, <strong>#{link_to "prilož ruku k dielu", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Rozhovory
|
||||
%p
|
||||
Zúčastnil som sa podcastu #{link_to "The Changelog", thechangelog},
|
||||
Zúčastnil som sa podcastu #{link_to "The Changelog", data.links.thechangelog},
|
||||
kde sme sa rozprávali o tom, prečo by sa správci projektov a prispievatelia
|
||||
mali zaujímať o changelogy a tiež o motivácii za týmto projektom.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Vodite changelog
|
||||
language: sr
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "http://5by5.tv/changelog/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Vodite Changelog
|
||||
%h2 Ne dajte prijateljima da trpaju git logove u changelogove.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Verzija
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -78,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
Datum izdavanja svake pojedine verzije treba biti vidljiv.
|
||||
%li
|
||||
Navesti prati li se #{link_to "Semantičko verzioniranje", semver}.
|
||||
Navesti prati li se #{link_to "Semantičko verzioniranje", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Vrste promena
|
||||
@ -175,12 +162,12 @@ version: 1.0.0
|
||||
od veće prema manjoj jedinici: godina, mesec, dan. Ovaj je format takođe
|
||||
teško zameniti s drugim regionalnim formatima, za razliku od nekih koji,
|
||||
primera radi, menjaju poziciju oznake meseca i dana.
|
||||
Iz tog razloga, a i zbog toga što je navedeni format #{link_to "ISO standard", iso},
|
||||
Iz tog razloga, a i zbog toga što je navedeni format #{link_to "ISO standard", data.links.isodate},
|
||||
taj se format preporučuje za changelog unose.
|
||||
|
||||
%aside
|
||||
Ali to nije sve. Pomozite u prikupljanju primera loše prakse
|
||||
= link_to "otvorivši issue", issues
|
||||
= link_to "otvorivši issue", data.links.issue
|
||||
ili pull request.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -193,19 +180,19 @@ version: 1.0.0
|
||||
Postoji li standardni changelog format?
|
||||
|
||||
%p
|
||||
Zapravo ne. Postoji #{link_to "GNU changelog stilski priručnik", gnustyle},
|
||||
i #{link_to "GNU NEWS file", gnunews}
|
||||
Zapravo ne. Postoji #{link_to "GNU changelog stilski priručnik", data.links.gnustyle},
|
||||
i #{link_to "GNU NEWS file", data.links.gnunews}
|
||||
"priručnik od dva odlomka". Nijedan nije adekvatan ni dovoljan.
|
||||
|
||||
%p
|
||||
Cilj ovoga projekta
|
||||
= link_to "kvalitetniji changelog standard.", changelog
|
||||
= link_to "kvalitetniji changelog standard.", data.links.changelog
|
||||
Nastao je prikupljanjem primera dobra prakse u
|
||||
open source zajednici.
|
||||
|
||||
%p
|
||||
Konstruktivna kritika, raprave i predlozi za poboljšanje
|
||||
= link_to "su dobrodošli.", issues
|
||||
= link_to "su dobrodošli.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -225,7 +212,7 @@ version: 1.0.0
|
||||
Šta s GitHub Releases?
|
||||
|
||||
%p
|
||||
To je ozbiljna inicijativa. #{link_to "Releases", ghr} se mogu koristiti
|
||||
To je ozbiljna inicijativa. #{link_to "Releases", data.links.github_releases} se mogu koristiti
|
||||
kako bi git oznake (npr. git oznaka <code>v1.0.0</code>) pretvorili
|
||||
u opširnije beleške o izdanju, upisujući ih ručno ili pak preuzimajući
|
||||
anotirane git oznake i pretvarajući ih u unose.
|
||||
@ -250,7 +237,7 @@ version: 1.0.0
|
||||
Teže, jer se koriste vrlo različiti formati, kao i nazivi datoteka.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} je Ruby gem koji je kreirao
|
||||
#{link_to "Vandamme", data.links.vandamme} je Ruby gem koji je kreirao
|
||||
Gemnasium tim i može parsirati mnoge (ali
|
||||
ne sve) changelogove projekata otvorenog koda.
|
||||
|
||||
@ -301,11 +288,11 @@ version: 1.0.0
|
||||
takođe, da je i sama rasprava bitna kao i krajnji rezultat.
|
||||
|
||||
%p
|
||||
Zato, molimo <strong>#{link_to "uskočite", gh}</strong>.
|
||||
Zato, molimo <strong>#{link_to "uskočite", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Razgovori
|
||||
%p
|
||||
Gostovao sam na #{link_to "The Changelog podcastu", thechangelog}
|
||||
Gostovao sam na #{link_to "The Changelog podcastu", data.links.thechangelog}
|
||||
gde sam pokušao objasniti zašto začetnici projekata i saradnici trebaju
|
||||
brinuti o changelogovima te motivaciji iza ovog projekta.
|
||||
|
||||
@ -4,25 +4,12 @@ title: För en ändringslogg
|
||||
language: sv
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 För en ändringslogg
|
||||
%h2 Låt inte dina vänner slänga in git-loggar i ändringsloggar.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
Datum då respektive version släpptes ska visas.
|
||||
%li
|
||||
Notering att du följer #{link_to "Semantisk versionshantering", semver}.
|
||||
Notering att du följer #{link_to "Semantisk versionshantering", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Typer av ändringar
|
||||
@ -174,12 +161,12 @@ version: 1.0.0
|
||||
på ett tvetydligt sätt med andra datumformat, till skillnad från
|
||||
lokala format som kan växla positionen på månad och dag.
|
||||
Dessa anledningar tillsammans med det faktum att detta datumformat är en
|
||||
#{link_to "ISO-standard", iso}, gör att detta är rekommenderat
|
||||
#{link_to "ISO-standard", data.links.isodate}, gör att detta är rekommenderat
|
||||
format för ändringsloggar.
|
||||
|
||||
%aside
|
||||
Det finns mer. Hjälp mig att samla dessa antimönster genom att
|
||||
= link_to "skapa ett issue", issues
|
||||
= link_to "skapa ett issue", data.links.issue
|
||||
eller en pull requests
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -192,18 +179,18 @@ version: 1.0.0
|
||||
Finns det ett standardformat på ändringsloggar?
|
||||
|
||||
%p
|
||||
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.
|
||||
Inte riktigt. #{link_to "GNU:s stilguide för ändringsloggar", data.links.gnustyle} och
|
||||
den #{link_to "två stycke långa GNU NEWS-filen", data.links.gnunews} med "riktlinjer" finns.
|
||||
Båda är bristfälliga och otillräckliga.
|
||||
|
||||
%p
|
||||
Detta projekt har som mål att bli
|
||||
= link_to "en bättre konvention för ändringsloggar.", changelog
|
||||
= link_to "en bättre konvention för ändringsloggar.", data.links.changelog
|
||||
Det utgår från uppenbart goda praxis från öppen källkods-världen och sammanför dem.
|
||||
|
||||
%p
|
||||
Konstruktiv kritik, diskussion och förslag till förbättring
|
||||
= link_to "är välkommen.", issues
|
||||
= link_to "är välkommen.", data.links.issue
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -223,7 +210,7 @@ version: 1.0.0
|
||||
Hur är det med GitHub Releases?
|
||||
|
||||
%p
|
||||
Det är ett fantasiskt initiativ. #{link_to "Releases", ghr} kan användas
|
||||
Det är ett fantasiskt initiativ. #{link_to "Releases", data.links.github_releases} kan användas
|
||||
för att göra enkla git-taggar (t.ex. en tagg kallad <code>v1.0.0</code>)
|
||||
till formaterade versionsanteckningar genom att manuellt lägga till
|
||||
versionsanteckningar eller så kan den hämta meddelandena i kommenterade
|
||||
@ -249,7 +236,7 @@ version: 1.0.0
|
||||
Det är svårt då människor följer vitt olika format och filnamn.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} är en Ruby gem skapad av gruppen
|
||||
#{link_to "Vandamme", data.links.vandamme} är en Ruby gem skapad av gruppen
|
||||
Gemnasium som tolkar många (men inte alla)
|
||||
ändringsloggar för öppen källkod.
|
||||
|
||||
@ -297,11 +284,11 @@ version: 1.0.0
|
||||
att diskussionen är lika viktig som slutresultatet.
|
||||
|
||||
%p
|
||||
Så tveka inte att <strong>#{link_to "kasta dig in i diskussionen", gh}</strong>.
|
||||
Så tveka inte att <strong>#{link_to "kasta dig in i diskussionen", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Samtal
|
||||
%p
|
||||
Jag var med i #{link_to "The Changelog podcast", thechangelog}
|
||||
Jag var med i #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
för att prata om varför förvaltare och bidragsgivare bör bry sig om
|
||||
ändringsloggar, och motiveringen bakom detta projekt.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Değişiklik kaydı tutun
|
||||
language: tr-TR
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Değişiklik kayıtları tutun
|
||||
%h2 Arkadaşlarınızın, git mesajlarını değişiklik kayıtlarına yığmasını engelleyin.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -76,7 +65,7 @@ version: 1.0.0
|
||||
%li
|
||||
Her sürümün dağıtım tarihi bulunmalıdır.
|
||||
%li
|
||||
Geliştirirken #{link_to "anlamlı sürümlendirme (Semver)", semver} kullanıp kullanmadığınızı bildirin.
|
||||
Geliştirirken #{link_to "anlamlı sürümlendirme (Semver)", data.links.semver} kullanıp kullanmadığınızı bildirin.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Değişiklik tipleri
|
||||
@ -170,12 +159,12 @@ version: 1.0.0
|
||||
<code>06-02-2012</code>), dünyanın bir çok bölümünde daha robotik bir
|
||||
kullanım <code>2 Haziran 2012</code> söz konusu. <code>2012-06-02</code>
|
||||
biçimi en küçüğünden en büyüğüne tüm biçimlerle çakışmadan kullanılabiliyor
|
||||
ve aynı zamanda bir #{link_to "ISO standardı", iso}. Bu sebeple değişiklik
|
||||
ve aynı zamanda bir #{link_to "ISO standardı", data.links.isodate}. Bu sebeple değişiklik
|
||||
kayıtları için önerilen tarih biçimidir.
|
||||
|
||||
%aside
|
||||
Mutlaka dahası da vardır. Benzer durumları toplamam için
|
||||
= link_to "bir çağrı açın", issues
|
||||
= link_to "bir çağrı açın", data.links.issue
|
||||
ya da bir çekme isteği gönderin.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -194,14 +183,14 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
Bu proje daha iyi
|
||||
= link_to "bir değişiklik kayıtları düzeni", changelog
|
||||
= link_to "bir değişiklik kayıtları düzeni", data.links.changelog
|
||||
oluşturmaya çalışıyor. Bunun için de açık kaynaklı topluluklardaki
|
||||
en iyi kullanımları inceleyip, topluyoruz.
|
||||
|
||||
%p
|
||||
Sağlıklı eleştiriler, tartışmalar ve öneriler, projenin gelişmesi
|
||||
için her zaman
|
||||
= link_to "hoş karşılanır.", issues
|
||||
= link_to "hoş karşılanır.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -223,7 +212,7 @@ version: 1.0.0
|
||||
Peki ya GitHub dağıtımları?
|
||||
|
||||
%p
|
||||
Harika bir girişim. #{link_to "Dağıtımlar", ghr} içine kendiniz
|
||||
Harika bir girişim. #{link_to "Dağıtımlar", data.links.github_releases} içine kendiniz
|
||||
değişiklik kayıtları eklerseniz basit git etiketlerini
|
||||
(örneğin <code>v1.0.0</code>) zengin dağıtım notlarına çevirebilir
|
||||
ya da notlar eklenmiş git etiketlerinden oluşturulabilirsiniz.
|
||||
@ -249,7 +238,7 @@ version: 1.0.0
|
||||
kullanıyorlar.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme}, Gemnasium
|
||||
#{link_to "Vandamme", data.links.vandamme}, Gemnasium
|
||||
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.
|
||||
|
||||
@ -299,12 +288,12 @@ version: 1.0.0
|
||||
İnanıyorum ki tartışmanın kendisi de sonucu kadar önemli.
|
||||
|
||||
%p
|
||||
Yani lütfen, <strong>#{link_to "siz de katılın", gh}</strong>.
|
||||
Yani lütfen, <strong>#{link_to "siz de katılın", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Sohbetler
|
||||
%p
|
||||
Geliştiricilerin ve katkıda bulunanların neden değişiklik kayıtlarını
|
||||
dikkate almaları gerekliliğini ve bu projenin arkasındaki motivasyonu
|
||||
anlattığım #{link_to "Değişiklik Kayıtları podcast", thechangelog}'ini
|
||||
anlattığım #{link_to "Değişiklik Kayıtları podcast", data.links.thechangelog}'ini
|
||||
inceleyebilirsiniz.
|
||||
|
||||
@ -4,23 +4,12 @@ title: Değişiklik kaydı tutun
|
||||
language: tr-TR
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main//CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Değişiklik kayıtları tutun
|
||||
%h2 Arkadaşlarınızın, git mesajlarını değişiklik kayıtlarına yığmasını engelleyin.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -76,7 +65,7 @@ version: 1.1.0
|
||||
%li
|
||||
Her sürümün dağıtım tarihi bulunmalıdır.
|
||||
%li
|
||||
Geliştirirken #{link_to "anlamlı sürümlendirme (Semver)", semver} kullanıp kullanmadığınızı bildirin.
|
||||
Geliştirirken #{link_to "anlamlı sürümlendirme (Semver)", data.links.semver} kullanıp kullanmadığınızı bildirin.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Değişiklik tipleri
|
||||
@ -170,7 +159,7 @@ version: 1.1.0
|
||||
<code>06-02-2012</code>), dünyanın bir çok bölümünde daha robotik bir
|
||||
kullanım <code>2 Haziran 2012</code> söz konusu. <code>2012-06-02</code>
|
||||
biçimi en küçüğünden en büyüğüne tüm biçimlerle çakışmadan kullanılabiliyor
|
||||
ve aynı zamanda bir #{link_to "ISO standardı", iso}. Bu sebeple değişiklik
|
||||
ve aynı zamanda bir #{link_to "ISO standardı", data.links.isodate}. Bu sebeple değişiklik
|
||||
kayıtları için önerilen tarih biçimidir.
|
||||
|
||||
%h4#inconsistent-changes
|
||||
@ -190,7 +179,7 @@ version: 1.1.0
|
||||
|
||||
%aside
|
||||
Mutlaka dahası da vardır. Benzer durumları toplamam için
|
||||
= link_to "bir çağrı açın", issues
|
||||
= link_to "bir çağrı açın", data.links.issue
|
||||
ya da bir çekme isteği gönderin.
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -209,14 +198,14 @@ version: 1.1.0
|
||||
|
||||
%p
|
||||
Bu proje daha iyi
|
||||
= link_to "bir değişiklik kayıtları düzeni", changelog
|
||||
= link_to "bir değişiklik kayıtları düzeni", data.links.changelog
|
||||
oluşturmaya çalışıyor. Bunun için de açık kaynaklı topluluklardaki
|
||||
en iyi kullanımları inceleyip, topluyoruz.
|
||||
|
||||
%p
|
||||
Sağlıklı eleştiriler, tartışmalar ve öneriler, projenin gelişmesi
|
||||
için her zaman
|
||||
= link_to "hoş karşılanır.", issues
|
||||
= link_to "hoş karşılanır.", data.links.issue
|
||||
|
||||
|
||||
%h4#filename
|
||||
@ -238,7 +227,7 @@ version: 1.1.0
|
||||
Peki ya GitHub dağıtımları?
|
||||
|
||||
%p
|
||||
Harika bir girişim. #{link_to "Dağıtımlar", ghr} içine kendiniz
|
||||
Harika bir girişim. #{link_to "Dağıtımlar", data.links.github_releases} içine kendiniz
|
||||
değişiklik kayıtları eklerseniz basit git etiketlerini
|
||||
(örneğin <code>v1.0.0</code>) zengin dağıtım notlarına çevirebilir
|
||||
ya da notlar eklenmiş git etiketlerinden oluşturulabilirsiniz.
|
||||
@ -264,7 +253,7 @@ version: 1.1.0
|
||||
kullanıyorlar.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme}, Gemnasium
|
||||
#{link_to "Vandamme", data.links.vandamme}, Gemnasium
|
||||
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.
|
||||
|
||||
@ -314,12 +303,12 @@ version: 1.1.0
|
||||
İnanıyorum ki tartışmanın kendisi de sonucu kadar önemli.
|
||||
|
||||
%p
|
||||
Yani lütfen, <strong>#{link_to "siz de katılın", gh}</strong>.
|
||||
Yani lütfen, <strong>#{link_to "siz de katılın", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Sohbetler
|
||||
%p
|
||||
Geliştiricilerin ve katkıda bulunanların neden değişiklik kayıtlarını
|
||||
dikkate almaları gerekliliğini ve bu projenin arkasındaki motivasyonu
|
||||
anlattığım #{link_to "Değişiklik Kayıtları podcast", thechangelog}'ini
|
||||
anlattığım #{link_to "Değişiklik Kayıtları podcast", data.links.thechangelog}'ini
|
||||
inceleyebilirsiniz.
|
||||
|
||||
@ -4,25 +4,12 @@ title: Ведіть Changelog
|
||||
language: uk
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnustyle = "https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs"
|
||||
- gnunews = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Ведіть Changelog
|
||||
%h2 Не дозволяйте друзям зливати логи гіта у лог змін.
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
Кожна версія має мати власну дату.
|
||||
%li
|
||||
Вкажіть чи підтримуєте Ви принципи #{link_to "Семантичне версіювання", semver}.
|
||||
Вкажіть чи підтримуєте Ви принципи #{link_to "Семантичне версіювання", data.links.semver}.
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Типи змін
|
||||
@ -172,12 +159,12 @@ version: 1.0.0
|
||||
найменшого: рік, місяць, день. Мінімізує конфузи у випадку використання
|
||||
регіональних форматів, коли день і місяць можуть мати різний порядок.
|
||||
Цей формат не пересікається з більшістю інших форматів і є
|
||||
#{link_to "стандартом ISO", iso}. Тому такий формат рекомендується для
|
||||
#{link_to "стандартом ISO", data.links.isodate}. Тому такий формат рекомендується для
|
||||
логів змін.
|
||||
|
||||
%aside
|
||||
Є також інші. Допоможіть зібрати антипатерни,
|
||||
= link_to "створіть тікет", issues
|
||||
= link_to "створіть тікет", data.links.issue
|
||||
або пул реквест
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -190,18 +177,18 @@ version: 1.0.0
|
||||
Чи існує стандарт логів змін?
|
||||
|
||||
%p
|
||||
Не зовсім. Є #{link_to "стайлгайд логів змін GNU", gnustyle}
|
||||
або #{link_to "довгий у два параграфа GNU NEWS file", gnunews}.
|
||||
Не зовсім. Є #{link_to "стайлгайд логів змін GNU", data.links.gnustyle}
|
||||
або #{link_to "довгий у два параграфа GNU NEWS file", data.links.gnunews}.
|
||||
Обидва неадекватні і неповні.
|
||||
|
||||
%p
|
||||
Цей проект покликаний бути
|
||||
= link_to "поліпшеною угодою про логи змін.", changelog
|
||||
= link_to "поліпшеною угодою про логи змін.", data.links.changelog
|
||||
Це виходить із ліпших практик open source спільноти.
|
||||
|
||||
%p
|
||||
Здорова критика, дискусія та пропозиції поліпшення
|
||||
= link_to "вітаються.", issues
|
||||
= link_to "вітаються.", data.links.issue
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -220,7 +207,7 @@ version: 1.0.0
|
||||
Як щодо GitHub релізів?
|
||||
|
||||
%p
|
||||
Це чудова ініціатива. #{link_to "Релізи", ghr} можуть бути використані для
|
||||
Це чудова ініціатива. #{link_to "Релізи", data.links.github_releases} можуть бути використані для
|
||||
перетворення простих тегів у Git (<code>v1.0.0</code> - до прикладу)
|
||||
у деталізовані нотатки до релізів шляхом їх редагування вручну або
|
||||
за допомогою коментарів до цих тегів.
|
||||
@ -246,7 +233,7 @@ version: 1.0.0
|
||||
імена файлів.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} - це гем для Ruby, створений
|
||||
#{link_to "Vandamme", data.links.vandamme} - це гем для Ruby, створений
|
||||
командою Gemnasium, який парсить багато (але не всі) логи
|
||||
змін проектів з відкритим кодом.
|
||||
|
||||
@ -294,11 +281,11 @@ version: 1.0.0
|
||||
Хотів би, щоб спільнота дійшла згоди. Я вірю у дискусію та результат.
|
||||
|
||||
%p
|
||||
Тому <strong>#{link_to "беріть участь", gh}</strong>.
|
||||
Тому <strong>#{link_to "беріть участь", data.links.repo}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Обговорення
|
||||
%p
|
||||
Я приходив на #{link_to "підкаст The Changelog", thechangelog}, щоб обговорити
|
||||
Я приходив на #{link_to "підкаст The Changelog", data.links.thechangelog}, щоб обговорити
|
||||
те, чому ментейнери та контриб'ютори повинні вести логи змін, а також
|
||||
про мою мотивацію для створення цього проекту.
|
||||
|
||||
@ -4,23 +4,12 @@ title: 如何维护更新日志
|
||||
language: zh-CN
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 如何维护更新日志
|
||||
%h2 更新日志绝对不应该是 git 日志的堆砌物
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -71,7 +60,7 @@ version: 1.0.0
|
||||
%li
|
||||
应包括每个版本的发布日期。
|
||||
%li
|
||||
注明是否遵守#{link_to "语义化版本规范", semver}。
|
||||
注明是否遵守#{link_to "语义化版本规范", data.links.semver}。
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types 变动类型
|
||||
@ -150,11 +139,11 @@ version: 1.0.0
|
||||
%p
|
||||
不同区域有着不同的时间格式，要找到让大家都满意的日期格式不是件容易的事。<code>2012-06-02</code>
|
||||
的格式从大到小排列符合逻辑、不容易与其他日期格式混淆，而且还符合
|
||||
#{link_to "ISO 标准", iso}。因此，推荐在更新日志中采用使用此种日期格式。
|
||||
#{link_to "ISO 标准", data.links.isodate}。因此，推荐在更新日志中采用使用此种日期格式。
|
||||
|
||||
%aside
|
||||
还有更多内容？请通过
|
||||
= link_to "Issues", issues
|
||||
= link_to "Issues", data.links.issue
|
||||
或是 Pull Request 协助收集。
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -171,10 +160,10 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
此项目旨在提供一个
|
||||
#{link_to "更好的更新日志范例", changelog}，所有点子都来自于对开源社区中优秀实例的观察与记录。
|
||||
#{link_to "更好的更新日志范例", data.links.changelog}，所有点子都来自于对开源社区中优秀实例的观察与记录。
|
||||
|
||||
%p
|
||||
欢迎#{link_to "提供", issues}有建设性的批评、讨论及建议。
|
||||
欢迎#{link_to "提供", data.links.issue}有建设性的批评、讨论及建议。
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -192,7 +181,7 @@ version: 1.0.0
|
||||
GitHub Releases 怎么样？
|
||||
|
||||
%p
|
||||
这是个非常好的提议。#{link_to "GitHub Releases", ghr}
|
||||
这是个非常好的提议。#{link_to "GitHub Releases", data.links.github_releases}
|
||||
可通过手动添加发布日志或将带有注释的 git 标签信息抓取后转换的方式，将简单的
|
||||
git 标签（如一个叫 <code>v1.0.0</code> 的标签）转换为信息丰富的发布日志。
|
||||
|
||||
@ -212,7 +201,7 @@ version: 1.0.0
|
||||
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} 是一个 Ruby 程序，由
|
||||
#{link_to "Vandamme", data.links.vandamme} 是一个 Ruby 程序，由
|
||||
Gemnasium 团队制作，可以解析多种（但绝对不是全部）开源库的更新日志。
|
||||
|
||||
|
||||
@ -252,10 +241,10 @@ version: 1.0.0
|
||||
希望我们的社区可以对此达成一致。我相信讨论的过程与最终结果一样重要。
|
||||
|
||||
%p
|
||||
所以欢迎<strong>#{link_to "贡献", gh}</strong>。
|
||||
所以欢迎<strong>#{link_to "贡献", data.links.repo}</strong>。
|
||||
|
||||
.press
|
||||
%h3 访谈
|
||||
%p
|
||||
我在 #{link_to "The Changelog podcast", thechangelog}
|
||||
我在 #{link_to "The Changelog podcast", data.links.thechangelog}
|
||||
上讲述了为何维护者与贡献者应关心更新日志，以及这个项目背后的动机。
|
||||
|
||||
@ -4,25 +4,12 @@ title: 如何維護更新日誌
|
||||
language: zh-TW
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md"
|
||||
- gh = "https://github.com/olivierlacan/keep-a-changelog"
|
||||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues"
|
||||
- semver = "https://semver.org/lang/zh-TW/"
|
||||
- shields = "https://shields.io/"
|
||||
- thechangelog = "https://changelog.com/podcast/127"
|
||||
- vandamme = "https://github.com/tech-angels/vandamme/"
|
||||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm"
|
||||
- ghr = "https://help.github.com/articles/creating-releases/"
|
||||
- gnu_changelog_styleguide = "https://www.gnu.org/prep/standards/html_node/Change-Logs.html"
|
||||
- gnu_the_news = "https://www.gnu.org/prep/standards/html_node/NEWS-File.html"
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 如何維護更新日誌
|
||||
%h2 別讓你的更新日誌成為 git log 的雙胞胎
|
||||
|
||||
= link_to changelog do
|
||||
= link_to data.links.changelog do
|
||||
Version
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
@ -77,7 +64,7 @@ version: 1.0.0
|
||||
%li
|
||||
每個版本都應該註記發佈日期。
|
||||
%li
|
||||
版本命名應遵守#{link_to "語意化版本", semver}格式。
|
||||
版本命名應遵守#{link_to "語意化版本", data.links.semver}格式。
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types 改動類型
|
||||
@ -159,11 +146,11 @@ version: 1.0.0
|
||||
%p
|
||||
在世界的每個角落，不同區域有著不同的時間格式，找到讓大家都滿意的日期格式不是件簡單的事。使用像
|
||||
<code>2017-07-17</code> 的格式能清楚傳達日期，而且不易與其他日期格式混淆，同時也遵守
|
||||
#{link_to "ISO 標準", iso}，因此推薦使用像這樣的日期格式。
|
||||
#{link_to "ISO 標準", data.links.isodate}，因此推薦使用像這樣的日期格式。
|
||||
|
||||
%aside
|
||||
其實還有許多應該避免的。大家可以透過
|
||||
= link_to "Issue", issues
|
||||
= link_to "Issue", data.links.issue
|
||||
或是 Pull Request 協助蒐集 ฅ' ω 'ฅ
|
||||
|
||||
.frequently-asked-questions
|
||||
@ -181,10 +168,10 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
這項專案的宗旨在於提供一個
|
||||
#{link_to "更好的更新日誌範例", changelog}，源於觀察開源社群中優秀的實際案例，把它們蒐集在一起。
|
||||
#{link_to "更好的更新日誌範例", data.links.changelog}，源於觀察開源社群中優秀的實際案例，把它們蒐集在一起。
|
||||
|
||||
%p
|
||||
歡迎各位#{link_to "提供", issues}有建設性的建議和批評。
|
||||
歡迎各位#{link_to "提供", data.links.issue}有建設性的建議和批評。
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
@ -202,7 +189,7 @@ version: 1.0.0
|
||||
那麼 GitHub Releases 呢？
|
||||
|
||||
%p
|
||||
這是個好問題。#{link_to "GitHub Releases", ghr}
|
||||
這是個好問題。#{link_to "GitHub Releases", data.links.github_releases}
|
||||
能手動在簡單的 git tag（如
|
||||
<code>v1.0.0</code>） 上附加豐富的版本資訊，也能把附帶的 tag
|
||||
messages 轉換成漂亮的日誌格式。
|
||||
@ -226,7 +213,7 @@ version: 1.0.0
|
||||
|
||||
%p
|
||||
另外，有些開源專案使用由 Gemnasium
|
||||
團隊開發的 #{link_to "Vandamme", vandamme}
|
||||
團隊開發的 #{link_to "Vandamme", data.links.vandamme}
|
||||
轉換更新日誌，或許可以當作參考。
|
||||
|
||||
%h4#yanked
|
||||
@ -263,9 +250,9 @@ version: 1.0.0
|
||||
源於我期望社群能達到共識，我相信討論的過程與結果一樣重要。
|
||||
|
||||
%p
|
||||
所以，<strong>#{link_to "加入我們", gh}</strong>吧 ٩(｡・ω・｡)و
|
||||
所以，<strong>#{link_to "加入我們", data.links.repo}</strong>吧 ٩(｡・ω・｡)و
|
||||
|
||||
.press
|
||||
%h3 訪談
|
||||
%p
|
||||
我在 #{link_to "The Changelog podcast", thechangelog} 上講述了為什麼維護者與協作者應該在意更新日誌，以及建立這項專案背後的契機。
|
||||
我在 #{link_to "The Changelog podcast", data.links.thechangelog} 上講述了為什麼維護者與協作者應該在意更新日誌，以及建立這項專案背後的契機。
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user