Following _Awesome_ guidelines
Closed this issue · 5 comments
What's the issue?
I'm the author of this pr to update the Awesome Mastodon link to this fork, but what I didn't know is that some guidelines here are not followed (blocking the PR).
Should things be updated to fix this?
Thanks for trying to get it into the list. I ran the awesome-lint
linter and it threw out a lot of issues, some of which seem a little pedantic:
README.md:522:1
✖ 1:1 Missing Awesome badge after the main heading remark-lint:awesome-badge
✖ 9:1 https://joinmastodon.org remark-lint:double-link
✖ 15:101 #official remark-lint:double-link
✖ 21:3 #official remark-lint:double-link
✖ 25:1 ToC item "Browser Extensions" does not match corresponding heading "Extensions" remark-lint:awesome-toc
✖ 37:3 https://joinmastodon.org remark-lint:double-link
✖ 46:38 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 47:39 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 48:30 https://m.webtoo.ls/@elk remark-lint:double-link
✖ 48:104 https://github.com/elk-zone/elk remark-lint:double-link
✖ 50:66 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 52:47 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 52:49 https://kaiteki.app/ remark-lint:double-link
✖ 52:84 https://floss.social/@Kaiteki remark-lint:double-link
✖ 52:129 https://github.com/Kaiteki-Fedi/Kaiteki remark-lint:double-link
✖ 53:38 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 54:35 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 55:39 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 56:43 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 58:47 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 58:49 https://nicolasconstant.github.io/sengi/ remark-lint:double-link
✖ 58:104 https://mastodon.social/@sengi_app remark-lint:double-link
✖ 58:154 https://nicolasconstant.github.io/sengi/ remark-lint:double-link
✖ 59:36 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 60:38 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 60:40 https://thedesk.top/en/ remark-lint:double-link
✖ 60:78 https://2m.cutls.com/@Cutls remark-lint:double-link
✖ 60:121 https://github.com/cutls/TheDesk remark-lint:double-link
✖ 61:41 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 62:41 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 62:43 https://mstdn.social/@trunksapp remark-lint:double-link
✖ 69:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 69:133 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 73:79 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 77:62 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 79:62 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 79:64 https://kaiteki.app/ remark-lint:double-link
✖ 79:99 https://floss.social/@Kaiteki remark-lint:double-link
✖ 79:144 https://github.com/Kaiteki-Fedi/Kaiteki remark-lint:double-link
✖ 81:85 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 81:87 https://joinmastodon.org/apps remark-lint:double-link
✖ 81:131 https://mastodon.social/@Mastodon remark-lint:double-link
✖ 82:3 Invalid list item remark-lint:awesome-list-item
✖ 83:3 Invalid list item remark-lint:awesome-list-item
✖ 83:5 Invalid list item remark-lint:awesome-list-item
✖ 86:60 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 87:89 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 88:79 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 88:82 https://tooot.app/ remark-lint:double-link
✖ 88:115 https://github.com/tooot-app/app remark-lint:double-link
✖ 89:79 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 89:81 https://mstdn.social/@trunksapp remark-lint:double-link
✖ 91:3 Invalid list item remark-lint:awesome-list-item
✖ 92:3 Invalid list item remark-lint:awesome-list-item
✖ 92:5 Invalid list item remark-lint:awesome-list-item
✖ 92:78 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 93:3 Invalid list item remark-lint:awesome-list-item
✖ 93:76 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 94:81 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 95:3 Invalid list item remark-lint:awesome-list-item
✖ 95:71 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 95:73 https://x.twidere.com/ remark-lint:double-link
✖ 104:73 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 107:74 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 108:73 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 109:3 https://apps.apple.com/us/app/mast-for-mastodon/id1437429129 remark-lint:double-link
✖ 109:85 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 110:77 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 110:79 https://joinmastodon.org/apps remark-lint:double-link
✖ 110:123 https://mastodon.social/@Mastodon remark-lint:double-link
✖ 112:64 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 113:90 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 114:66 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 115:66 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 115:68 https://mastodon.social/@MonaApp remark-lint:double-link
✖ 116:54 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 117:79 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 118:60 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 118:62 https://tooot.app/ remark-lint:double-link
✖ 118:95 https://github.com/tooot-app/app remark-lint:double-link
✖ 119:59 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 120:54 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 120:56 https://2m.cutls.com/@Cutls remark-lint:double-link
✖ 121:77 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 122:88 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 123:66 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 124:67 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 125:68 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 125:70 https://mstdn.social/@trunksapp remark-lint:double-link
✖ 126:62 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 127:3 https://apps.apple.com/app/twidere-x/id1530314034 remark-lint:double-link
✖ 127:65 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 127:67 https://x.twidere.com/ remark-lint:double-link
✖ 127:104 https://github.com/TwidereProject/TwidereX-iOS remark-lint:double-link
✖ 128:81 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 132:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 132:50 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 141:64 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 141:66 https://m.webtoo.ls/@elk remark-lint:double-link
✖ 141:106 https://github.com/elk-zone/elk remark-lint:double-link
✖ 142:36 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 144:69 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 145:62 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 145:64 https://nicolasconstant.github.io/sengi/ remark-lint:double-link
✖ 145:119 https://mastodon.social/@sengi_app remark-lint:double-link
✖ 145:169 https://nicolasconstant.github.io/sengi/ remark-lint:double-link
✖ 146:55 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 146:57 https://thedesk.top/en/ remark-lint:double-link
✖ 146:95 https://2m.cutls.com/@Cutls remark-lint:double-link
✖ 146:138 https://github.com/cutls/TheDesk remark-lint:double-link
✖ 147:75 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 147:77 https://x.twidere.com/ remark-lint:double-link
✖ 147:114 https://apps.apple.com/app/twidere-x/id1530314034 remark-lint:double-link
✖ 147:247 https://github.com/TwidereProject/TwidereX-iOS remark-lint:double-link
✖ 148:70 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 151:70 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 155:3 https://apps.apple.com/us/app/mast-for-mastodon/id1437429129 remark-lint:double-link
✖ 155:85 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 156:68 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 157:69 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 157:71 https://mastodon.social/@MonaApp remark-lint:double-link
✖ 162:62 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 178:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 179:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 179:81 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 180:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 180:144 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 181:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 181:37 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 182:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 183:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 184:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 185:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 185:44 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 186:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 186:112 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 186:125 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 187:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 188:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 188:40 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 189:3 Marker style should be * remark-lint:unordered-list-marker-style
✖ 189:67 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 190:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 190:61 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 191:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 191:44 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 192:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 192:58 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 193:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 193:74 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 194:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 194:112 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 200:132 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 203:83 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 205:54 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 206:44 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 207:58 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 208:49 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 209:36 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 210:100 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 216:42 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 217:36 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 218:46 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 219:47 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 220:55 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 221:38 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 222:59 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 224:163 List item description must start with valid casing remark-lint:awesome-list-item
✖ 224:248 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 229:34 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 230:48 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 231:54 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 232:60 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 233:45 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 239:65 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 240:36 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 241:48 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 242:38 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 243:39 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 244:48 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 248:39 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 251:62 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 252:40 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 260:75 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 261:50 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 262:60 List item description must start with valid casing remark-lint:awesome-list-item
✖ 266:74 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 268:80 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 269:88 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 274:44 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 275:40 List item description must start with valid casing remark-lint:awesome-list-item
✖ 276:66 List item description must start with valid casing remark-lint:awesome-list-item
✖ 280:88 List item description must start with valid casing remark-lint:awesome-list-item
✖ 281:81 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 282:73 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 283:38 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 284:96 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 285:88 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 289:34 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 290:71 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 291:40 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 292:72 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 293:70 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 294:45 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 298:91 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 300:59 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 301:75 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 304:54 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 308:197 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 328:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 328:70 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 329:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 329:34 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 330:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 330:25 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 331:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 331:26 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 332:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 333:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 334:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 334:77 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 335:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 336:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 340:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 341:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 342:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 343:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 347:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 347:122 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 351:1 Marker style should be * remark-lint:unordered-list-marker-style
✖ 357:3 https://joinmastodon.org/ remark-lint:double-link
✖ 358:79 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 359:58 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 362:37 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 363:41 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 364:52 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 365:57 List item description must start with valid casing remark-lint:awesome-list-item
✖ 368:67 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 369:36 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 375:70 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 376:67 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 381:35 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 397:79 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 398:65 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 399:63 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 401:5 https://pixelfed.org/mobile-apps remark-lint:double-link
✖ 401:51 https://mastodon.social/@pixelfed/ remark-lint:double-link
✖ 404:75 https://pixelfed.org/mobile-apps remark-lint:double-link
✖ 404:122 https://mastodon.social/@pixelfed/ remark-lint:double-link
✖ 413:53 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 421:54 List item description must start with valid casing remark-lint:awesome-list-item
✖ 428:70 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 429:38 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 430:51 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 437:51 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 439:5 Text "Javascript" should be written as "JavaScript" remark-lint:awesome-spell-check
✖ 441:53 Text "node.js" should be written as "Node.js" remark-lint:awesome-spell-check
✖ 445:56 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 449:54 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 450:43 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 454:52 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 458:48 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 462:48 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 466:53 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 473:33 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 474:51 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 476:35 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 479:40 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 480:32 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 481:63 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 487:106 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 492:50 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 515:71 List item description must start with valid casing remark-lint:awesome-list-item
✖ 516:78 List item description must start with valid casing remark-lint:awesome-list-item
✖ 522:1 Don’t add a trailing . to headings remark-lint:no-heading-punctuation
✖ 526:1 https://example.org remark-lint:double-link
✖ 526:45 https://example.org remark-lint:double-link
✖ 526:79 https://example.org remark-lint:double-link
✖ 526:114 https://example.org remark-lint:double-link
✖ 526:157 https://example.org remark-lint:double-link
✖ 543:3 Invalid list item link remark-lint:awesome-list-item
✖ 544:3 Invalid list item remark-lint:awesome-list-item
✖ 545:3 Invalid list item remark-lint:awesome-list-item
✖ 546:3 Invalid list item remark-lint:awesome-list-item
284 errors
I'm not really inclined to spend time fixing each of these to bring the list in line with what seem to be quite extensive and rather opinionated guidelines, especially when I think some of the deviations are useful, such as the links to mobile apps and some of the double links.
I see, yeah there are a lot of rule violations. But are you saying you won't fix all of the issues? Because I think that is a requirement to be listed on the main awesome list.
Yeah there are some lints I maybe disagree with, but it's part of the requirements. I'm looking at the list and it seems you would also have to change your default branch to main
, renaming LICENSE.md
to either LICENSE
or license
, and probably others.
I guess that is your decision then to retain some improvements while violating the admittedly strict awesome guidelines? It doesn't look like they are lenient with any repositories they accept...