Create readme.md

This commit is contained in:
José De Freitas 2021-02-06 14:54:38 -05:00 committed by GitHub
parent e47c9a4006
commit e8a94f613e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

17
linter/readme.md Normal file
View File

@ -0,0 +1,17 @@
# Awesome YouTubers linter
The awesome-youtubers linter is a workflow that checks the layout of the pull requests opened. This helps the contributors show if
something in the layout is not formatted correctly so it can be fixed. This linter was created in order to keep the format of the
list without breaking the layouts (images, new lines, etc.)
## Rules
The rules that the linter follows are:
- Trailing `\` at the end of the name and link of the YouTuber.
- Trailing `\` at the end of the "Content about" section.
- Trailing `\` at the end of the "Featured playlists" section.
- Spaces between badges.
- Spaces between "Content about" words (including `,`).
- Spaces between "Featured playlists" words (including `,`).
- Links formatted correctly in the markdown syntax (`[text](link)`)