Awesome-Mirrors/awesome-youtubers
1
0
Fork 0
mirror of https://github.com/JoseDeFreitas/awesome-youtubers.git synced 2024-12-22 05:45:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21 from catcecilia/readme

Browse Source 
Editing the contribution page
This commit is contained in:
José De Freitas 2020-10-03 09:07:51 -05:00 committed by GitHub
commit 47f45e164b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
contributing.md
View File

@ -1,29 +1,49 @@
# Contribution guidelines
Please follow the [code of conduct](https://github.com/JoseDeFreitas/awesome-youtubers/blob/master/code-of-conduct.md).
Note that "YouTube channel", "channel" and "youtuber" mean the same thing in [this repository](https://github.com/JoseDeFreitas/awesome-youtubers).
Note that "YouTube channel", "channel" and "YouTuber" mean the same thing in [this repository](https://github.com/JoseDeFreitas/awesome-youtubers).
- [Channel rules](#channel-rules)
- [Add a youtuber](#add-a-youtuber)
- [Youtuber template](#youtuber-template)
- [Pull request template](#pull-request-template)
- [Open issues](#open-issues)
Only add youtubers that are **awesome**! *"After all, it's a curation, not a collection"*. [What is awesome?](https://github.com/sindresorhus/awesome/blob/main/awesome.md#only-awesome-is-awesome)
It doesn't matter if the youtuber isn't active anymore; if the youtuber has videos/playlists uploaded but no new videos, it still counts. Follow the channel rules below when deciding on what youtuber to add.
## Channel rules
- The channel is focused on the technology and the youtuber also teaches about tech-related content. Examples of acceptable topics: JavaScript tutorials, web design, command-line cmdlets. Examples of not acceptable topics: freelancing as an illustrator, laws in the technology industry, personal finance tips, makeup, jokes.
- It must be an entire YouTube channel (a youtuber). You can't add only one video or playlist.
- The channel should be made up of content created by the YouTuber. Do not add channels that create playlists and add videos from other youtubers.
- The channel must follow the [YouTube terms](https://www.youtube.com/t/terms) and any other rules provided by YouTube.
- The channel must be primarily English.
**_For awesome YouTubers in other languages:_** Please contribute to the corresponding language list located in the [other-languages folder](https://github.com/JoseDeFreitas/awesome-youtubers/tree/master/other-languages/readme-non_en.md). Rules still apply to non-english channels as well.)
## Add a youtuber
Please, only add youtubers that are actually **awesome**! *"After all, it's a curation, not a collection"*. [What is awesome?](https://github.com/sindresorhus/awesome/blob/main/awesome.md#only-awesome-is-awesome)
It doesn't matter if the youtuber isn't active anymore; if the youtuber has videos/playlists uploaded but no new videos, it still counts.
To add a youtuber, you will need to create a pull request from a forked repository.
To add a youtuber, fork this repository, then (in the fork you've created) create a new branch (to do this, in your fork main page, click on the "main" brach. You'll see an input. In there, type the name of the branch you want (please keep the name accordingly to the repository) and click on "create branch: NAME_OF_BRANCH from 'main'". If you're using the cli, do: `git checkout -b NAME_OF_BRANCH`.) After that, edit the readme.md file (make sure you're in the branch you've just created) and add the youtuber to the existing section you consider it fits well or you can also create another section if you need to (if you will, please keep in mind that a section holds several YouTube channels and is intended to work as it). **Add the youtuber at the bottom of the category**. *Jump to the [Pull request template](#pull-request-template) to know how to open a pull request*.
- On the upper right, click on the fork button
- In the fork you've created, create a new branch (If you're using command line, do: `git checkout -b NAME_OF_BRANCH`.)
- Edit the readme.md file in the branch you've just created.
- Using the YouTuber template down below, add the youtuber(s) to the appropriate section **at the bottom of the section** or create another section if you need to (a section holds several YouTube channels, please use discretion).
For a channel to be added, you need to follow these rules:
- The channel is tech-related and the youtuber also teaches about teach stuff. It doesn't has to be mainly tech-related, but the content of the channel should at least be able to be used in technology. To explain me better, I'll give you these examples: a channel about JavaScript tutorials, a channel about web design, a channel about command-line cmdlets - these are mainly tech-related. A channel about freelancing as an illustrator, a channel about laws in the technology, a channel about how to keep track and save your money could not be mainly tech-related, but can be used and applied to tech. A channel about makeup or a channel about compilations of every-day jokes don't apply to this list.
- It must be an entire YouTube channel (a youtuber). You can't add only one video or playlist.
- Make sure the videos/playlists are actually from the YouTube channel you're submitting! A YouTube channel can create playlists and add videos from other youtubers; to keep the content concise and corresponding to the submission, make sure the videos on the playlists are made and uploaded by the youtuber you're submitting.
- The channel must be mainly English. There're good youtubers whose content isn't in English, that's why you can still add them but they need to be added into the markdown file, in the [other-languages folder](https://github.com/JoseDeFreitas/awesome-youtubers/tree/master/other-languages/readme-non_en.md), corresponding to the language the channel is in (the [code of conduct](https://github.com/JoseDeFreitas/awesome-youtubers/blob/master/code-of-conduct.md) and these rules apply **the same** to non-english channels.)
- The link to the channel must redirect only to the youtuber's channel main page (it **shouldn't** redirect to one of their videos or to a specific channel section) (eg. https://www.youtube.com/user/github or https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ). Please **do not use any link shortener** and ensure that the link doesn't have any youtube parameter (eg. like the parameter that redirects the user to the subscribe button.)
- To get the avatar of the channel, go to the main channel's page, right-click the avatar and select "copy image adress". Use that link in the layout (please don't modify the image as any means. Also, don't change the width and/or height attributes on the `<img>` tag.)
- Please add the badges accordingly to the channel (only add the badges if the channel meets the badges requirements) (refer to [badges.md](https://github.com/JoseDeFreitas/awesome-youtubers/blob/master/badges.md)). **Do not** change any badge layout and please follow the order in badges.md (as "verified channel" appears at first, do so when adding the channel. If the channel doesn't meet the first badge, keep the order with the other ones. If it doesn't meet any requirement just don't add any). Please only use the links to the badges in the [media folder](https://github.com/JoseDeFreitas/awesome-youtubers/tree/master/media).
- The channel must follow the [YouTube terms](https://www.youtube.com/t/terms) and any other rules provided by YouTube.
- You should follow the layout style and positioning, which is this:
*Jump to the [Pull request template](#pull-request-template) to know how to open a pull request*.
How to use the YouTuber template:
- Do not use link shorteners
- Do not change any layout or attributes in the template
- Fill out the template with YouTuber information replacing items in ALL_CAPS and the featured playlist section
- The link to the channel must redirect only to the youtuber's channel main page (it **shouldn't** redirect to one of their videos specific channel section, or subscribe button) (eg. https://www.youtube.com/user/github or https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ).
- To get the avatar of the channel, go to the main channel's page, right-click the avatar and select "copy image adress". Paste the image address to replace the LINK_TO_THE_AVATAR_OF_THE_YOUTUBE_CHANNEL in the template. (Do not modify the image or change the width and/or height attributes on the `<img>` tag.)
- If the channel meets any badge requirements, add accordingly (refer to [badges.md](https://github.com/JoseDeFreitas/awesome-youtubers/blob/master/badges.md)). If the channel doesn't meet badge(s) requirements, delete that badge and keep the order with the other ones. Channels do not need to meet any badge requirement.
- The "Content about" section **should not** be more than **1** line.
- The "Featured playlists" section **should not** be more than **2** lines.
- If the youtuber doesn't have any playlist, you can consider a series of videos as a playlist or type "`None`".
### YouTuber template:
```html
[<img align="left" height="94px" width="94px" alt="NAME_OF_THE_YOUTUBE_CHANNEL channel's avatar" src="LINK_TO_THE_AVATAR_OF_THE_YOUTUBE_CHANNEL"/>](LINK_TO_THE_CHANNEL)
@ -43,10 +63,9 @@ Featured playlists: `playlist-1`, `playlist-2`, `playlist-3`, `playlist-4`.
...
```
*The "Content about" section **should not** be more than **1** line. In this section, describe the main content of the channel.*
*The "Featured playlists" section **should not** be more than **2** lines. In this section, put the best playlists of the youtuber. This is because as the youtuber should at least teach (maybe not explicitly) something according to its channel content. It doesn't have to be a literal YouTube playlist though; this is preferable, but if the youtuber doesn't have any playlist, you can consider as a playlist a series of videos. If still you consider the youtuber doesn't have any playlists, you can type "`None`".*
**The "Featured playlists" section could lead to some layout problems**. If the "Featured playlists" section is 2 lines, there won't be any problem with the layout. But, if the "Featured playlists" section is just 1 line, the youtuber below it will broke the layout. To solve this, add a line break `<br/>` just below the "Featured playlists" line. REMEMBER to also add `\` after the "Featured playlists" section (in the same line). In the example above there should be a `<br/>` below the "Featured playlists" section, but I didn't put it to prevent confuse.
**The "Featured playlists" section could lead to some layout problems**. If the "Featured playlists" section is only 1 line, the youtuber below will have a broken layout. To solve this, add a line break `<br/>` below the "Featured playlists" line. REMEMBER to also add `\` after the "Featured playlists" section (in the same line).
Example:
@ -60,7 +79,16 @@ Featured playlists: `Open Source Friday`, `GitHub Satellite 2020 - Work`, `Publi
### Pull request template
When you finished adding the youtuber(s), open a pull request. To open a pull request, go to the [Pull request section in this repository](https://github.com/JoseDeFreitas/awesome-youtubers/pulls), then click on "New pull request" and therefore click on "compare across forks". After that, select the fork you've created (it should be `your_github_username/awesome-youtubers`) and the branch you've created in your fork. **You need to select these two options in the right-hand side of the arrow "<-" icon. Don't change the two options on the left (whose should be "base repository: JoseDeFreitas/awesome-youtubers" and "base: main".)** Click on "Create pull request", select a title and copy & fill the pull request template you can find below. Then click on "Create pull request" and you're ready!
When you finished adding the youtube channel(s) on the forked repository, open a pull request.
To open a pull request:
- Go to the [Pull request section in this repository](https://github.com/JoseDeFreitas/awesome-youtubers/pulls)
- Click on "New pull request"
- Click on "compare across forks".
- Change the two options on the right-hand side of the arrow "<-" icon to be the fork you've created (it should be `your_github_username/awesome-youtubers`) and the branch you've created in your fork. **Don't change the two options on the left (whose should be "base repository: JoseDeFreitas/awesome-youtubers" and "base: main".)**
- Click on "Create pull request"
- Write a title and copy & fill the pull request template you can find below.
- Click on "Create pull request" and you're all set!
You can add any number of youtubers at a time in just one pull request. *The label "new youtuber" will get automatically added when you open the pull request*. To keep the order, please follow this pull request syntax (copy and paste):