« The End State of Systems that grow by Accretion | Main | Moth »
Sunday
Oct252020

Linking to a Github Repository

DateSun 2020-10-25

In general, when you link to a Gihub repository you should include the #readme fragment in the URL instead of just linking to the bare repository URL.  This means users don't have to scroll down to find out what he repository holds. For example: you should prefer

https://github.com/rust-lang/rust#readme

over:

https://github.com/rust-lang/rust

AuthorTristram Brelstaff | CommentPost a Comment |
in

Reader Comments

There are no comments for this journal entry. To create a new comment, use the form below.

PostPost a New Comment

Enter your information below to add a new comment.
Author Email (optional):
Author URL (optional):
Post:
 
All HTML will be escaped. Hyperlinks will be created for URLs automatically.

Notify me of follow-up comments via email.