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

Update CONTRIBUTING.md

This commit is contained in:
Aleksandr Statciuk 2021-09-09 00:09:50 +03:00
parent 5d76cc2dac
commit 1572f1c799
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

@ -152,15 +152,14 @@ http://example.com/stream.m3u8
- `.github/` - `.github/`
- `ISSUE_TEMPLATE/`: issue templates for this repository. - `ISSUE_TEMPLATE/`: issue templates for this repository.
- `workflows/` - `workflows/`
- `auto-update.yml`: GitHub Action that automatically updates all playlists every day. - `auto-update.yml`: GitHub workflow that automatically updates all playlists every day.
- `check.yml`: GitHub Action that automatically checks every pull request for syntax errors. - `check.yml`: GitHub workflow that automatically checks every pull request for syntax errors.
- `cleanup.yml`: GitHub workflow that automatically removes broken links every week.
- `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.
- `.readme/` - `.readme/`
- `_categories.md`: automatically generated list of all categories and their corresponding playlists.
- `_countries.md`: automatically generated list of all countries and their corresponding playlists.
- `_languages.md`: automatically generated list of all languages and their corresponding playlists.
- `config.json`: config for the `markdown-include` package, which is used to compile everything into one `README.md` file. - `config.json`: config for the `markdown-include` package, which is used to compile everything into one `README.md` file.
- `preview.png`: image displayed in the `README.md`. - `preview.png`: image displayed in the `README.md`.
- `supported-categories.md`: list of supported categories.
- `supported-region-codes.md`: list of supported region codes. - `supported-region-codes.md`: list of supported region codes.
- `template.md`: template for `README.md`. - `template.md`: template for `README.md`.
- `channels/`: contains all channels broken down by the country from which they are broadcast. - `channels/`: contains all channels broken down by the country from which they are broadcast.
@ -168,13 +167,13 @@ http://example.com/stream.m3u8
- `unsorted.m3u`: playlist with channels not yet sorted. - `unsorted.m3u`: playlist with channels not yet sorted.
- `scripts/` - `scripts/`
- `data/`: data used in scripts. - `data/`: data used in scripts.
- `helpers/`: helper scripts used in GitHub Actions. - `helpers/`: helper scripts.
- `filter.js`: used within GitHub Action to remove blacklisted channels from playlists. - `filter.js`: used within GitHub workflow to remove blacklisted channels from playlists.
- `format.js`: used within GitHub Action to format channel descriptions. - `format.js`: used within GitHub workflow to format channel descriptions.
- `generate.js`: used within GitHub Action to generate all additional playlists. - `generate.js`: used within GitHub workflow to generate all additional playlists.
- `remove-duplicates.js`: used in GitHub Action to remove duplicates from the playlist. - `remove-broken-links.js`: used in GitHub workflow to remove broken links from the playlist.
- `sort.js`: used within GitHub Action to sort channels by name. - `remove-duplicates.js`: used in GitHub workflow to remove duplicates from the playlist.
- `update-readme.js`: used within GitHub Action to update the `README.md` file. - `sort.js`: used within GitHub workflow to sort channels by name.
- `update-readme.js`: used within GitHub workflow to update the `README.md` file.
- `CONTRIBUTING.md`: file you are currently reading. - `CONTRIBUTING.md`: file you are currently reading.
- `index.m3u`: main playlist that contains links to all playlists in the `channels/` folder.
- `README.md`: project description generated from the contents of the `.readme/` folder. - `README.md`: project description generated from the contents of the `.readme/` folder.