Please please please can package developers put a link BACK to the source repo inside your documentation! Without it, the documentation becomes a trap.
It is becoming more common now that Google is taking me to documentation pages rather than the Github repo. I frequently flip back and forth between code and documentation, but this process is beyond cumbersome if the documentation contains no easily accessible link to the code with which it is associated. Links are free to use!
[](https://github.com/USER/PACKAGE.jl)
and then use it as the docstring of the module by this one-linear
so that the badge is included in the documentation (e.g., https://tkf.github.io/BangBang.jl/dev/#BangBang.BangBang). I like that it provides useful bits of information while also providing the link to the repository (though it relies on that people already know that badges are often clickable).
For fun, you can find other github-related badges in https://shields.io/ (type github in the search form).
It usually takes you to the gh-pages branch of the repo, so one should make additional click to switch to the main page of the repository. It’s not a big issue, but it is annoying when you do it 100th time.
As a side note, it can be a small fix of the corresponding PkgTemplates template also.
