From ce855c9cb031470419bde2bdea99cf22187c6695 Mon Sep 17 00:00:00 2001 From: Aleksandr Statciuk Date: Sat, 24 Sep 2022 04:51:02 +0300 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 52 ++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5371f335..d5d8de5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,31 +19,31 @@ ### channels -| Field | Description | Required | Example | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------ | -| id | Unique channel ID derived from the `name` and `country` separated by dot. May only contain Latin letters, numbers and dot. | Required | `AnhuiTV.cn` | -| name | Official channel name in English. May include: `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `!`, `:`, `&`, `.`, `+`, `'`, `/`, `»`, `#`, `%`, `°`, `$`, `@`, `?`, `(`, `)`. | Required | `Anhui TV` | -| native_name | Channel name in the original language. Used when different from `name`. May contain any characters except `,` and `"`. | Optional | `安徽卫视` | -| network | Network of which this channel is a part. | Optional | `Anhui` | -| country | Country code from which the channel is transmitted. A list of all supported countries and their codes can be found in [data/countries.csv](data/countries.csv) | Required | `CN` | -| subdivision | Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted. A list of all supported subdivisions and their codes can be found in [data/subdivisions.csv](data/subdivisions.csv) | Optional | `CN-AH` | -| city | Name of the city from which the channel is transmitted. May only contain `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `'`. | Optional | `Hefei` | -| broadcast_area | List of codes describing the broadcasting area of the channel. Any combination of `r/`, `c/`, `s/` | Required | `s/CN-AH` | -| languages | List of languages in which the channel is broadcast separated by `;`. A list of all supported languages and their codes can be found in [data/languages.csv](data/languages.csv) | Required | `zho` | -| categories | List of categories to which this channel belongs separated by `;`. A list of all supported categories can be found in [data/categories.csv](data/categories.csv) | Optional | `general` | -| is_nsfw | Indicates whether the channel broadcasts adult content (`TRUE` or `FALSE`) | Required | `FALSE` | -| launched | Launch date of the channel (`YYYY-MM-DD`) | Optional | `2016-07-28` | -| closed | Date on which the channel closed (`YYYY-MM-DD`) | Optional | `2020-05-31` | -| replaced_by | The ID of the channel that this channel was replaced by. | Optional | `CCTV1.cn` | -| website | Official website URL. | Optional | `http://www.ahtv.cn/` | -| logo | Logo URL. Only URL with HTTPS protocol are allowed. Supported image types: `PNG`, `JPEG`. | Required | `https://example.com/logo.png` | +| Field | Description | Required | Example | +| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------ | +| id | Unique channel ID derived from the `name` and `country` separated by dot. May only contain Latin letters, numbers and dot. | Required | `AnhuiTV.cn` | +| name | Official channel name in English. May include: `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `!`, `:`, `&`, `.`, `+`, `'`, `/`, `»`, `#`, `%`, `°`, `$`, `@`, `?`, `(`, `)`. | Required | `Anhui TV` | +| native_name | Channel name in the original language. Used when different from `name`. May contain any characters except `,` and `"`. | Optional | `安徽卫视` | +| network | Network of which this channel is a part. | Optional | `Anhui` | +| country | Country code from which the channel is transmitted. A list of all supported countries and their codes can be found in [data/countries.csv](data/countries.csv) | Required | `CN` | +| subdivision | Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted. A list of all supported subdivisions and their codes can be found in [data/subdivisions.csv](data/subdivisions.csv). | Optional | `CN-AH` | +| city | Name of the city from which the channel is transmitted. May only contain `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `'`. | Optional | `Hefei` | +| broadcast_area | List of codes describing the broadcasting area of the channel. Any combination of `r/`, `c/`, `s/`. | Required | `s/CN-AH` | +| languages | List of languages in which the channel is broadcast separated by `;`. A list of all supported languages and their codes can be found in [data/languages.csv](data/languages.csv). | Required | `zho` | +| categories | List of categories to which this channel belongs separated by `;`. A list of all supported categories can be found in [data/categories.csv](data/categories.csv). | Optional | `general` | +| is_nsfw | Indicates whether the channel broadcasts adult content (`TRUE` or `FALSE`). | Required | `FALSE` | +| launched | Launch date of the channel (`YYYY-MM-DD`). | Optional | `2016-07-28` | +| closed | Date on which the channel closed (`YYYY-MM-DD`). | Optional | `2020-05-31` | +| replaced_by | The ID of the channel that this channel was replaced by. | Optional | `CCTV1.cn` | +| website | Official website URL. | Optional | `http://www.ahtv.cn/` | +| logo | Logo URL. Only URL with HTTPS protocol are allowed. Supported image types: `PNG`, `JPEG`. | Required | `https://example.com/logo.png` | ### categories -| Field | Description | Required | Example | -| ----- | -------------- | -------- | ------- | -| id | Category ID. | Required | `news` | -| name | Category name. | Required | `News` | +| Field | Description | Required | Example | +| ----- | ------------- | -------- | ------- | +| id | Category ID | Required | `news` | +| name | Category name | Required | `News` | ### languages @@ -58,14 +58,14 @@ | ----- | ------------------------------------------------------------------------------------------ | -------- | ------------ | | name | Official name of the country | Required | `Martinique` | | code | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country | Required | `MQ` | -| lang | Official language in the country. | Required | `fra` | +| lang | Official language in the country | Required | `fra` | | flag | Country flag emoji | Required | `🇲🇶` | ### subdivisions | Field | Description | Required | Example | | ------- | ------------------------------------------------------------------------------ | -------- | ------------------ | -| country | Country code of the division. | Required | `CA` | +| country | Country code of the division | Required | `CA` | | name | Official subdivision name | Required | `British Columbia` | | code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code of the subdivision | Required | `CA-BC` | @@ -73,9 +73,9 @@ | Field | Description | Required | Example | | --------- | ---------------------------------------------------------------------------------------------------------------------- | -------- | ---------------- | -| name | Official name of the region. | Required | `Central Asia` | +| name | Official name of the region | Required | `Central Asia` | | code | Abbreviated designation for the region. May only contain Latin letters in upper case. The minimum length is 3 letters. | Required | `CAS` | -| countries | List of country codes in the region. | Required | `KG;KZ;TJ;TM;UZ` | +| countries | List of country codes in the region | Required | `KG;KZ;TJ;TM;UZ` | ### blocklist