openjournals / joss

The Journal of Open Source Software
https://joss.theoj.org
MIT License
1.46k stars 183 forks source link

Pre-submission enquiry #1339

Open HPicatto opened 1 month ago

HPicatto commented 1 month ago

I am currently preparing to submit a paper to the Journal of Open Source Software and intend to publish the accompanying code. The codebase is housed in a private GitHub repository. Due to confidentiality constraints, not all content in the repository can be made public at the time of the paper's publication. To comply with JOSS's open-source requirements, I am considering creating a parallel public repository that includes only the components releasable at this stage. However, I am concerned that this approach might result in the loss of the original commit history and the contributions' authorship records. Could you please advise on the best practices or recommend strategies for managing this situation?

logological commented 1 month ago

Are the individual components that you can publically release under an OSI-approved licence usable and useful without the ones that you will be holding back? If not, then the software may not meet JOSS's core "obvious research application" requirement.

Regarding the authorship records, AFAIK there's no requirement that these take the form of a Git commit log. You could instead credit the authors in comments in the individual source files, and/or in a dedicated text file listing the contributors.

sneakers-the-rat commented 1 month ago

not commenting on scope, but you could fork the repo and use git-filter-repo to remove the stuff you need to keep private, preserving the rest of the repo history