Skip to content

Commit

Permalink
Extend CIP-0001 to cover internationalized content (#542)
Browse files Browse the repository at this point in the history
  • Loading branch information
KtorZ authored Jul 7, 2023
1 parent 421e644 commit 3b1b8e7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CIP-0001/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -140,6 +141,29 @@ 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
--- | ---
`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`)
`Translators` | A list of translators names and email addresses (e.g. `John Doe <[email protected]>`)
`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.
Expand Down

0 comments on commit 3b1b8e7

Please sign in to comment.