The badge

The badge, in the README of a paper's code, sends the code's readers to the paper's page on OSCR: the paper beside the code, its tracing map, its citation.

What the badge is

One image for every paper, /badge.svg: a flat rectangle with the platform's name and "paper ↔ code". What makes it yours is the link around it, to your paper's page. There is no image per paper — the site keeps a fixed number of files — and the badge says nothing that could become false.

Getting your snippet

Signed in as a verified author of the paper, or a maintainer of its code, open the paper's page: its Contribute section shows "Add the badge to its README" with three snippets, already pointing to the paper's page, each with a Copy button. They look like this:

Markdown (a README.md)

[![OSCR](https://openscicode.org/badge.svg)](https://openscicode.org/paper/<your paper>/)

reStructuredText (a README.rst)

.. image:: https://openscicode.org/badge.svg
   :target: https://openscicode.org/paper/<your paper>/
   :alt: OSCR

HTML

<a href="https://openscicode.org/paper/<your paper>/"><img src="https://openscicode.org/badge.svg" alt="OSCR"></a>

Adding it on GitHub

For each GitHub repository of the paper, the section links to its README in GitHub's own editor (or to the repository when it has none). Paste the snippet at the top, and GitHub offers to commit it, or to open a pull request if you cannot write to the repository. Elsewhere, edit the README as you usually do.

Why no pull request is made for you

A one-click pull request would need your GitHub authorization with the public_repo scope, which gives write access to every public repository you have. OSCR never asks GitHub for any permission: the badge is added by you, in GitHub's editor — your consent is in the gesture itself. The brand page gives the badge's rules of use.