Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend CIP-0001 to cover internationalized content #542

Merged
merged 3 commits into from
Jul 7, 2023
Merged

Extend CIP-0001 to cover internationalized content #542

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8369b72
Extend CIP-0001 to cover internationalized content
KtorZ Jul 4, 2023
38f3561
Update CIP-0001/README.md
KtorZ Jul 4, 2023
9f184fa
Update CIP-0001/README.md
KtorZ Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CIP-0001/README.md
View file
Open in desktop
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,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
KtorZ marked this conversation as resolved.
Show resolved Hide resolved
`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