CODEWITHSUNDEEP
github
Alex
Alex

Reputation: 44385

How to fix wrong link in CONTRIBUTING.md in a github repository?

When you have a github repository you might have a file CONTRIBUTING.md which describes how users can contribute to this project.

In a file CONTRIBUTING.md in one of our groups repositories the following raw text

Please do not hesitate to raise an issue on [github project page][github].

creates the text

Please do not hesitate to raise an issue on github project page.

where github project page is a link that leads to a different github repository!

So the internal link [github] (or what this is) leads to a different repository. I also do not understand what the two square brackets together mean

[github project page][github]

as a link usually is created with a normal and a square bracket

[GitHub Pages](https://pages.github.com/)

The project has been renamed, but the link leads to a completely different github repository.

How can I fix this? How can I change the link of the internal link [github]? Or where can I find documentation about this feature?

Upvotes: 1

Views: 36

Answers (1)

Alex
Alex

Reputation: 44385

It turns out it is a kind of reference defined at the end of the file!

So for the above example you can define this reference at the end of your file as follows:

[github]: https://github.com/YourGroup/YourRepo

Not sure this is documented.

Upvotes: 1

Related Questions