ckyri015
/
iptv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
freearhey 2021-04-26 02:33:01 +03:00
parent 4d861fe1c4
commit 12e02e6832
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -25,11 +25,11 @@ If you have an idea how to improve the project create an [issue](https://github.
## Request a Channel ## Request a Channel
To request a channel, create an [issue](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=channel+request&template=-----channel-request.md&title=Add%3A+xxx) and complete all details requested. (**IMPORTANT:** the issue should contain a request for only one channel, otherwise it will be closed immediately). Understand that our community of volunteers will try to help you, but if a public link cannot be found, there is little we can do. To request a channel, create an [issue](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=channel+request&template=------channel-request.md&title=Add%3A+xxx) and complete all details requested. (**IMPORTANT:** the issue should contain a request for only one channel, otherwise it will be closed immediately). Understand that our community of volunteers will try to help you, but if a public link cannot be found, there is little we can do.
## Report a Broken Stream ## Report a Broken Stream
To report a broadcast that is not working, create an [issue](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=broken+stream&template=---broken-stream.md&title=Fix%3A+xxx) with a description of the channel (**IMPORTANT:** an issue should contain a report for only one channel, otherwise it will be closed immediately). To report a broadcast that is not working, create an [issue](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=broken+stream&template=----broken-stream.md&title=Fix%3A+xxx) with a description of the channel (**IMPORTANT:** an issue should contain a report for only one channel, otherwise it will be closed immediately).
## Add or Replace a Stream ## Add or Replace a Stream
@ -234,11 +234,7 @@ http://example.com/stream.m3u8
## Project Structure ## Project Structure
- `.github/` - `.github/`
- `ISSUE_TEMPLATE/` - `ISSUE_TEMPLATE/`: issue templates for this repository.
- `broken-stream.md`: issue template for reporting a broken stream.
- `channel-request.md`: template for channel request.
- `feature-request.md`: template for feature request.
- `remove-channel.md`: template for channel deletion request.
- `workflows/` - `workflows/`
- `auto-update.yml`: contain actions that automatically updates all playlists every day. - `auto-update.yml`: contain actions that automatically updates all playlists every day.
- `CODE_OF_CONDUCT.md`: rules you shouldn't break if you don't want to get banned. - `CODE_OF_CONDUCT.md`: rules you shouldn't break if you don't want to get banned.
@ -254,7 +250,9 @@ http://example.com/stream.m3u8
- ... - ...
- `unsorted.m3u`: playlist with channels not yet sorted. - `unsorted.m3u`: playlist with channels not yet sorted.
- `scripts/` - `scripts/`
- `blacklist.json`: list of channels banned for addition to the repository.
- `categories.json`: list of supported categories. - `categories.json`: list of supported categories.
- `db.js`: contains functions for retrieving and managing the channel list.
- `format.js`: used within GitHub Action to sort channels and remove duplicates from each playlist. - `format.js`: used within GitHub Action to sort channels and remove duplicates from each playlist.
- `generate.js`: used within GitHub Action to generate all additional playlists. - `generate.js`: used within GitHub Action to generate all additional playlists.
- `parser.js`: contains functions for parsing playlists. - `parser.js`: contains functions for parsing playlists.