practicajs / practica

Node.js solution starter boilerplate that is production-ready, packed with βœ… best practices and built with simplicity in mind

Home Page:https://practica.dev/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

contribution-short-guide link broken in CONTRIBUTING.md file

vishal-sharma-369 opened this issue Β· comments

In the CONTRIBUTING.md file , the link for contribution-short-guide page in the below section is broken.

Consider the shortened guide first

Every small change can make this repo much better. If you intend to contribute a relatively small change like documentation change, small code enhancement or anything that is small and obvious - start by reading the shortened guide here. As you'll expand your engagement with this repo, it might be a good idea to visit this long guide again

Issue : Here the link for contribution-short-guide link is not working

Hey @vishal-sharma-369 πŸ™‹β€β™‚οΈ, welcome.

Yes, just noted that. This is because the link is related with the web version, any idea how to make it work for both GitHub.com and a website?

Updating the link for the (shortened-guide-here) would resolve the issue in the below section:

Consider the shortened guide first

Every small change can make this repo much better. If you intend to contribute a relatively small change like documentation change, small code enhancement or anything that is small and obvious - start by reading the shortened guide here. As you'll expand your engagement with this repo, it might be a good idea to visit this long guide again

Issue : Link broken
Solution :
Updating the source of shortened-guide-here file from "/docs/docs/contribution/contribution-short-guide" to "/docs/docs/contribution/contribution-short-guide.md" would resolve the issue.

Adding .md extension at the end of source resolved the issue.

It works now 🎯🎈πŸ’ͺ @vishal-sharma-369

Thanks!