###About
The Open Source Metatag is a way of telling developers where to access the source code for your website, if the source code is hosted in an open source repository on the public internet.
To include an open source metatag on your website, simply add <meta />
tags for the following properties:
os:repo
- This should be a link to the repository web page, for instance the project page on GitHub, Bitbucket, or Sourceforge.os:rcs_type
- This should be the name of the revision control system used, for instance Git, Mercurial, Bazaar.os:src
- This is the repository url that can be used to obtain a copy of the source.
This is not a place to link to code that is described on your website; rather, this is for the code for the actual website. That way, if anyone reading your website sees an error - a spelling mistake, broken CSS, etc. - or something they want to examine - a cool paralax library, etc. - they can quickly fetch the source code.
###Example
<meta property="os:repo" content="https://github.com/RichardLitt/open-source-metatags" />
<meta property="os:repo" content="git" />
<meta property="os:src" content="git@github.com:RichardLitt/open-source-metatags.git" />
###Optional tags
Other tags that can be used:
os:issue
- This links to a place to report issues for the website.os:branch
- This should be the name of the branch the website is based off (where applicable).
####Examples
<meta property="os:issue" content="https://github.com/RichardLitt/open-source-metatags/issues" />
<meta property="os:branch" content="gh-pages" />
###Shields
For use in the repository, to show your compliance and spread the word:
https://img.shields.io/badge/OSMT-passing-green.svg
https://img.shields.io/badge/OSMT-failing-red.svg
###Contribute
This is a work in progress. Please open an issue to discuss how the Open Source Metatags can be improved. PRs are encouraged!