matiassingers / awesome-readme

A curated list of awesome READMEs
18.25k stars 3.84k forks source link

Add abijwe #260

Closed akashbijwe closed 2 months ago

akashbijwe commented 6 months ago

All the observations from this thread are resolved, please add this readme. https://github.com/matiassingers/awesome-readme/issues/256#event-12704335368

Robson commented 6 months ago

Thank you for looking into these things - glad they were useful.

Just reviewing the original list:

When submitting the pull request, please use the URL: https://github.com/akashbijwe/akashbijwe#readme

✅ Done

Some technology names need little tweaks: Javascript -> JavaScript. Typescript -> TypeScript. Mongo DB -> MongoDB. There may be more.

✅ Done

Some wording changes would be good: "In a free time I love to contribute on open-source community." -> "In my free time I love to contribute to the open-source community."

✅ Done

There's a website URL listed in an image, but no clickable link to it.

ℹ I think this would be beneficial because it'll let users access your site easier and it'll increase engagement for your site. Could be achieved by splitting the contact image into two (one for the e-mail and one for the website), then wrap the image in an a tag to link to the website. Happy to add this to the repository without that though.

Several of the social media links are 404 errors, private accounts, have no content or are closed services.

✅ Done

Possibly a temporary issue, but some social images at the end aren't working for me. Notably the 5th and 6th ones. They say "Not found" when going to the image locations.

✅ Done

I like the images used throughout, but this doesn't feel accessible. Maybe there is some way to improve that, such as using alt text for the images. I'm not sure if there is a way to achieve this content using tables/etc, but possibly worth investigating.

ℹ Definitely worth considering this from an accessibility perspective. All it would take is putting the text on the alt tags, then the readme would work normally and with screenreaders. Happy to add this to the repository without that though.

meduzen commented 6 months ago

Hi, shimming in! On top of the missing images alt text, I have two concerns regarding this kind of repository promoted as awesome:

Thou it’s visually appealing, I would rather encourage to build this as a website, or at least to split every images in two (left/right) and inline them so it stacks up on mobile, like a responsive website 😃.

akashbijwe commented 6 months ago

Thanks @Robson for reviewing it thoroughly 💯, I have added the alt to the images.

akashbijwe commented 6 months ago

Hello @meduzen , Yes, you are right! I have compressed the images all image size is not less than 80kb but It's now reduced to 180kb from 500kb.

Robson commented 5 months ago

Hi @akashbijwe Do you have any thoughts on the two remaining items? That's the accessibility and the unclickable website URL.

akashbijwe commented 5 months ago

Hey @Robson,

  1. I have added the alt for all the images
  2. For this I think it's just fine, I have added the link to my website in the Find me around the web 🌎 section.

    I think this would be beneficial because it'll let users access your site easier and it'll increase engagement for your site. Could be achieved by splitting the contact image into two (one for the e-mail and one for the website), then wrap the image in an a tag to link to the website. Happy to add this to the repository without that though.

Thank you for the thoroughly reviewing my profile page, really appreciate it. 💯

Robson commented 4 months ago

Hi @akashbijwe Thank you for looking into this. Visually this readme looks good, but I have too many issues with it to be able to consider it awesome. All issues have already been raised in this ticket, but I will repeat them in case that is helpful:

I see three ways forward from here:

or

or

Robson commented 2 months ago

Activity on this has slowed, so I'm going to close this pull request. Do feel free to reopen, if all issues raised are resolved.