From 8369b72cfb2ae0a66cd05ea947d2aabd53ffdbdd Mon Sep 17 00:00:00 2001 From: KtorZ Date: Tue, 4 Jul 2023 15:48:23 +0200 Subject: [PATCH 1/3] Extend CIP-0001 to cover internationalized content --- CIP-0001/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 5227a37832..bd4ca23a66 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -41,6 +41,7 @@ The CIP process does not _by itself_ offer any form of governance. For example, - [Document](#document) - [Structure](#structure) - [Header Preamble](#header-preamble) + - [Translations](#translations) - [Repository Organization](#repository-organization) - [Licensing](#licensing) - [Statuses](#statuses) @@ -140,6 +141,28 @@ CIP-0010 ``` +##### Translations + +While CIPs are mainly technical documents meant to be read primarily by developers -- and thus often written in English; some may be translated into various languages to increase their outreach. Any file in a CIP folder may also include translated content satisfying the following rules: + +- Any translated file shall share a common basename with its original source. + +- Translation file basenames must have a suffix using an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code, separated by a dot `.` character. (e.g. `README.fr.md`). + +- When no language code is provided as suffix, the default language for the document is assumed to be English (UK/US). + +- Translated CIPs (i.e. `README` files), must not include the original preamble. They must, however, include the following preamble as yaml frontmatter data: + +Field | Description +--- | --- +`Source` | A link to the original CIP document +`Title` | A translation of the CIP's title +`Revision` | The commit hash (8-10 first hex-digits) of the source (e.g. `12ab34cd`) +`Translators` | A list of translators names and email addresses (e.g. `John Doe `) +`Language` | An [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of the target language (e.g. `fr`) + +- Translated CIPs inherit the same licensing terms as their original sources. + ##### Licensing CIPs are licensed in the public domain. Moreso, they must be licensed under one of the following licenses. Each new CIP must identify at least one acceptable license in its preamble. In addition, each license must be referenced by its respective abbreviation below in the _"Copyright"_ section. From 38f35618971ff826453e57d9b8b8781a347cac86 Mon Sep 17 00:00:00 2001 From: Matthias Benkort <5680256+KtorZ@users.noreply.github.com> Date: Tue, 4 Jul 2023 19:17:38 +0200 Subject: [PATCH 2/3] Update CIP-0001/README.md Co-authored-by: Robert Phair --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index bd4ca23a66..5d870a75c8 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -155,7 +155,7 @@ While CIPs are mainly technical documents meant to be read primarily by develope Field | Description --- | --- -`Source` | A link to the original CIP document +`Source` | The canonical GitHub link to the original CIP document `Title` | A translation of the CIP's title `Revision` | The commit hash (8-10 first hex-digits) of the source (e.g. `12ab34cd`) `Translators` | A list of translators names and email addresses (e.g. `John Doe `) From 9f184fa2d3ddd256c82f29ba8c475080a6443d8b Mon Sep 17 00:00:00 2001 From: Matthias Benkort <5680256+KtorZ@users.noreply.github.com> Date: Fri, 7 Jul 2023 20:10:28 +0200 Subject: [PATCH 3/3] Update CIP-0001/README.md Co-authored-by: Robert Phair --- CIP-0001/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 5d870a75c8..f61b44f63c 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -155,6 +155,7 @@ While CIPs are mainly technical documents meant to be read primarily by develope Field | Description --- | --- +`CIP` | The CIP number (without leading 0) `Source` | The canonical GitHub link to the original CIP document `Title` | A translation of the CIP's title `Revision` | The commit hash (8-10 first hex-digits) of the source (e.g. `12ab34cd`)