Skip to content

Commit a8d7eb8

Browse files
authored
Merge pull request #38249 from iptv-org/BellezaEmporium-patch-1
[CONTRIBUTING & FAQ.md] improve clarity and structure
2 parents f306b1f + 8551b76 commit a8d7eb8

2 files changed

Lines changed: 15 additions & 14 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## How to?
1010

11-
### How to add a new stream link to a playlists?
11+
### How to add a new stream link to a playlist?
1212

1313
You have several options:
1414

@@ -18,25 +18,25 @@ You have several options:
1818

1919
Regardless of which option you choose, before posting your request please do the following:
2020

21-
- Make sure the link you want to add works stably. To check this, open it in one of the players (for example, [VLC player](https://www.videolan.org/vlc/index.html)) and watch the broadcast for at least a minute (some test streams are interrupted after 15-30 seconds).
21+
- Make sure the link you want to add is stable, and works properly. To check this, open it in one of your usual players (for example, [VLC media player](https://www.videolan.org/vlc/index.html)) and watch the broadcast for at least a minute (some test streams are interrupted after 15-30 seconds).
2222
- Make sure the link is not already in the playlist. This can be done by [searching](https://github.com/search?q=repo%3Aiptv-org%2Fiptv+http%3A%2F%2Fexample.com&type=code) the repository.
23-
- Make sure the link does not lead to the Xtream Codes server. [Why don't you accept links to Xtream Codes server?](FAQ.md#why-dont-you-accept-links-to-xtream-codes-server)
23+
- Make sure the link does not lead to a Xtream Codes server. [Why don't you accept links to Xtream Codes servers?](FAQ.md#why-dont-you-accept-links-to-xtream-codes-servers). If you're unsure, please check [How to distinguish a link to an Xtream Codes server from a regular one?](#how-to-distinguish-a-link-to-an-xtream-codes-server-from-a-regular-one)
2424
- Make sure that the link leads directly to the broadcast, without unnecessary redirects.
25-
- Find the ID of the channel you want on [iptv-org.github.io](https://iptv-org.github.io/). If your desired channel is not on the list you can leave a request to add it [here](https://github.com/iptv-org/database/issues/new/choose).
26-
- Make sure the channel is not blocklisted. It can also be done through [iptv-org.github.io](https://iptv-org.github.io/).
25+
- Find the ID of the channel you want on [iptv-org.github.io](https://iptv-org.github.io/). If your desired channel is not on the list, you must add it via a request [here](https://github.com/iptv-org/database/issues/new/choose).
26+
- Make sure the channel is not blacklisted. It can also be done through [iptv-org.github.io](https://iptv-org.github.io/).
2727
- If you know that the broadcast only works in certain countries or it is periodically interrupted, do not forget to indicate this in the request.
2828

29-
A requests without a valid stream ID or working link to the stream will be closed immediately.
29+
A request without a valid stream ID or working link to the stream will be closed immediately.
3030

3131
Note all links in playlists are sorted automatically by scripts so there is no need to sort them manually. For more info, see [Scripts](#scripts).
3232

3333
### How to fix the stream description?
3434

35-
Most of the stream description (channel name, feed name, categories, languages, broadcast area, logo) we load from the [iptv-org/database](https://github.com/iptv-org/database) using the stream ID.
35+
Most of the stream description (channel name, feed name, categories, languages, broadcast area, logo) is loaded from [iptv-org/database](https://github.com/iptv-org/database) using the stream ID.
3636

37-
So first of all, make sure that the desired stream has the correct ID. A full list of all supported channels and their corresponding IDs can be found on [iptv-org.github.io](https://iptv-org.github.io/). To change the stream ID of any link in the playlist, just fill out this [form](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=streams%3Aedit&projects=&template=2_streams_edit.yml&title=Edit%3A+).
37+
First of all, make sure that the desired stream has the correct ID. A full list of all supported channels and their corresponding IDs can be found on [iptv-org.github.io](https://iptv-org.github.io/). To change the stream ID of any link in the playlist, just fill out this [form](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=streams%3Aedit&projects=&template=2_streams_edit.yml&title=Edit%3A+).
3838

39-
If, however, you have found an error in the database itself, this is the place to go: [How to edit channel description?](https://github.com/iptv-org/database/blob/master/CONTRIBUTING.md#how-to-edit-channel-description)
39+
If, however, you have found an error in the database itself, please refer to: [How to edit channel description?](https://github.com/iptv-org/database/blob/master/CONTRIBUTING.md#how-to-edit-channel-description)
4040

4141
### How to distinguish a link to an Xtream Codes server from a regular one?
4242

@@ -63,7 +63,7 @@ An issue without a valid link will be closed immediately.
6363

6464
### How to find a broken stream?
6565

66-
For starters, you can just try to open the playlist in [VLC player](https://www.videolan.org/vlc/). The player outputs all errors to the log (Tools -> Messages) so you'll be able to determine pretty accurately why a link isn't working.
66+
For starters, you can just try to open the playlist in [VLC media player](https://www.videolan.org/vlc/). The player outputs all errors to the log (Tools -> Messages) so you'll be able to determine pretty accurately why a link isn't working.
6767

6868
Another way to test links is to use the NPM script. To do this, first make sure you have [Node.js](https://nodejs.org/en) installed on your system. Then go to the `iptv` folder using [Console](https://en.wikipedia.org/wiki/Windows_Console) (or [Terminal](<https://en.wikipedia.org/wiki/Terminal_(macOS)>) if you have macOS) and run the command:
6969

@@ -150,7 +150,7 @@ http://example.com/stream.m3u8
150150
- `preview.png`: image displayed in the `README.md`.
151151
- `template.md`: template for `PLAYLISTS.md`.
152152
- `scripts/`: contains all scripts used in the repository.
153-
- `streams/`: contains all streams broken down by the country from which they are broadcast.
153+
- `streams/`: contains all streams broken down by country from which they are broadcasted.
154154
- `tests/`: contains tests to check the scripts.
155155
- `CONTRIBUTING.md`: file you are currently reading.
156156
- `PLAYLISTS.md`: auto-updated list of available playlists.
@@ -168,7 +168,7 @@ To run scripts use the `npm run <script-name>` command.
168168
- `act:format`: allows to test the [format](https://github.com/iptv-org/iptv/blob/master/.github/workflows/update.yml) workflow locally. Depends on [nektos/gh-act](https://github.com/nektos/gh-act).
169169
- `act:update`: allows to test the [update](https://github.com/iptv-org/iptv/blob/master/.github/workflows/update.yml) workflow locally. Depends on [nektos/gh-act](https://github.com/nektos/gh-act).
170170
- `api:load`: downloads the latest channel and stream data from the [iptv-org/api](https://github.com/iptv-org/api).
171-
- `playlist:format`: formats internal playlists. The process includes [URL normalization](https://en.wikipedia.org/wiki/URI_normalization), duplicate removal, removing invalid id's and sorting links by channel name, quality, and label.
171+
- `playlist:format`: formats internal playlists. The process includes [URL normalization](https://en.wikipedia.org/wiki/URI_normalization), duplicate removal, removing invalid ids and sorting links by channel name, quality, and label.
172172
- `playlist:update`: triggers an update of internal playlists. The process involves processing approved requests from issues.
173173
- `playlist:generate`: generates all public playlists.
174174
- `playlist:validate`: сhecks ids and links in internal playlists for errors.

FAQ.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ No.
1212

1313
### Why is the channel on the iptv-org.github.io but not in the playlist?
1414

15-
The site contains a list of all TV channels in the world and only those of them for which we have working stream links are included in the playlists.
15+
The site is an extensive database of all existing TV channels in the world, and does not represent a list of streams in our possession. Only those of them for which we have working stream links are included in the playlists.
16+
You may still check [iptv-org.github.io](https://iptv-org.github.io) with the "streams:>0" parameter in the search bar to check all available streams.
1617

1718
### Can I add a radio broadcast?
1819

1920
Yes, if it is a [visual radio](https://en.wikipedia.org/wiki/Visual_radio) in which a video and audio are shown at the same time.
2021

21-
### Why don't you accept links to Xtream Codes server?
22+
### Why don't you accept links to Xtream Codes servers?
2223

2324
Xtream Codes streams tend to be very unstable, and often links to them fail very quickly, so it's easier for us to initially exclude them from the playlist than to search for expired ones every day.

0 commit comments

Comments
 (0)