Bug: Wrong format to add your profiles in oss.gg folder

0xJaskeerat commented 1 month ago

Preliminary Checks

[X] I have reviewed the documentation: https://unkey.com/docs
[X] I have searched for existing issues: https://github.com/unkeyed/unkey/issues
[X] This issue is not a question, general help request, or anything other than a bug report directly related to Unkey. Please ask questions in our Discord community: https://unkey.com/discord.

Reproduction / Replay Link (Optional)

No response

Issue Summary

Contributors are adding X username handles underneath clickable names When there's already a place to add the link to X account literally in the next sentence

Steps to Reproduce

Head over to Link
Take this example and click on Teddy ASSIH » 04-October-2024 by Teddy ASSIH » Link to Account: https://x.com/ion_finisher
As soon as you click on the name , you'll land on a 404 page
You'll find this by clicking on every contributor's name

Expected behavior

Landing on contributor's Github Account is a much better option rather than just plan X username that redirect to 404 page

Take this example and click on Jaskeerat Singh to verify

» 14-October-2024 by Jaskeerat Singh » Link to Account: https://x.com/0xJaskeerat

Other information

No response

Screenshots

Clicking on any Contributor's name takes me to following

Version info

- OS: iOS
- Node: v20.8.1
- npm: v10.9.0x

linear[bot] commented 1 month ago

ENG-1469 Bug: Wrong format to add your profiles in oss.gg folder

0xJaskeerat commented 1 month ago

@MichaelUnkey Can we add a new guideline for contributors to follow this Only if the Open source team agrees too with my suggestion

chronark commented 1 month ago

What problem does this solve?

0xJaskeerat commented 1 month ago

What problem does this solve?

@chronark Not a tech problem , but if you click on any contributor's name , you will land on 404

Coz by default the format to add a link in github markdown is

(Shown text for link) [Link]

But contributors have added (Contributor Name) [Twitter Username ( not a valid link,leading to 404 redirection )]

Example I have shared in Steps To Reproduce section in issue description

chronark commented 1 month ago

That's fine, I don't see a problem with that

unkeyed / unkey