{"id":28780929,"url":"https://github.com/andreww/publishing_your_code","last_synced_at":"2026-02-06T02:03:54.203Z","repository":{"id":66469848,"uuid":"299231678","full_name":"andreww/publishing_your_code","owner":"andreww","description":"Some notes and resources to help take software from a research project to a research software publication","archived":false,"fork":false,"pushed_at":"2020-10-21T10:43:22.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-09T07:26:26.506Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andreww.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-09-28T07:53:05.000Z","updated_at":"2025-02-24T08:50:45.000Z","dependencies_parsed_at":"2024-08-12T05:02:14.081Z","dependency_job_id":null,"html_url":"https://github.com/andreww/publishing_your_code","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andreww/publishing_your_code","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreww%2Fpublishing_your_code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreww%2Fpublishing_your_code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreww%2Fpublishing_your_code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreww%2Fpublishing_your_code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreww","download_url":"https://codeload.github.com/andreww/publishing_your_code/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreww%2Fpublishing_your_code/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29145565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T01:13:33.096Z","status":"online","status_checked_at":"2026-02-06T02:00:08.092Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-17T18:08:51.074Z","updated_at":"2026-02-06T02:03:54.195Z","avatar_url":"https://github.com/andreww.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Publishing Your Code\nMany researchers will produce software as part of their research and, in order to\ngain recognition of the work involved in this, as well as to enable reuse, it can be\nbeneficial to formally publish this software. This repository contains a collection\nof notes and resources to help researchers publish software for the first time. The\nmaterial may eventually form the basis of a short course or workshop.\n\n## Target, aims, and objectives\nThere are many potential venues for the publication of research software and many\nwho may benifit from publishing their software. Software can be made available\nonline in multiple ways and described within theses, in conference proceedings, or\nalongside the research results. Here I focus on the researcher who has developed\nsoftware for the first time, has probably generated some scientific insight using\nthat software, and is now ready to prepare the software for wider dissemination. In\nparticular, I imagine publication in the the \n[Journal of Open Source Software](https://joss.theoj.org/), but the process of preparing\nfor publication there will also cover most other targets. More importantly, the process\nof preparing the first peice of research software for publication should provide\nvaluable lessons for the development of future software. Applying these lessons \nshould make it easer develop and share software in future.\n\nReviewing for JOSS involves judging submitted software against a [short \nchecklist](https://joss.readthedocs.io/en/latest/review_checklist.html) and \n[criteria](https://joss.readthedocs.io/en/latest/review_criteria.html) but rather\nthan stucture the material here around these lists I have attempted to arrange\nthings in an order that makes sense for a first time developer rather than a \nreviewer (who is likly to be a more experianced developer). My hope is that if\nsomebody works through the material in the order presented here they will\nbe in a position to publish their software, to act as a reviewer for software\npublications, and that the order that material is presented follows a logical\npath.\n\n## Content\n\n1. What's interesting about your software?\n2. A stand-alone package or part of something else?\n3. [Version control: getting organised](version_control.md).\n4. Applying a software license.\n5. Got any tests?\n6. Types of documentation.\n7. [Using version control to work with others](version_control_repos.md).\n8. Reviewing your code\n9. Automating tests and running them regularly.\n10. Documenting installation and use.\n11. Where are the gremlins.\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003e\u003cimg alt=\"Creative Commons Licence\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work by \u003ca xmlns:cc=\"http://creativecommons.org/ns#\" href=\"https://github.com/andreww/publishing_your_code/\" property=\"cc:attributionName\" rel=\"cc:attributionURL\"\u003eAndrew Walker\u003c/a\u003e is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003eCreative Commons Attribution 4.0 International License\u003c/a\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreww%2Fpublishing_your_code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreww%2Fpublishing_your_code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreww%2Fpublishing_your_code/lists"}