Publishing your GitHub Repository

When you're ready to tell the world about your GitHub repo, consider the following:

  • Check that the "About" section and the contents of are both up to date. People will see these sections prominently when they click a link to your repository on GitHub.
    • Include a link to the paper or other published, final outputs in
    • Include a short, one-line summary and link to your paper or outputs in the "About" section. Click the cog next to "About" and add these details.
  • Check the LICENSE file exists, and that it allows modification and distribution without cost. We recommend the MIT Licence (example).
  • Consider making a GitHub Release, and linking to that (instructions here). A Release is a coherent snapshot of the code as it existed at a given point in time, along with a title and a description. By default, releases are displayed on your repo home page. For example, you might make separate releases of the code to accompany a preprint and the final versions of the paper.
  • Try to ensure your automated tests (on the repo's Actions tab) are green. It's not essential, but it is a better look to be able to demonstrate your code is minimally runnable.
  • Review your GitHub repository to make it simpler for people to explore:
    • Are there old issues that can be closed? Some issues may have been fixed, or may be no longer relevant.
    • Are there unneeded branches that can be deleted? Old branches may contain draft work or previous ideas that are no longer needed.
  • If your repository is private, make it public before the associated paper or output is published.