Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JOSS submission #311

Open
alexarje opened this issue Nov 19, 2023 · 1 comment
Open

JOSS submission #311

alexarje opened this issue Nov 19, 2023 · 1 comment
Assignees

Comments

@alexarje
Copy link
Contributor

@balintlaczko and I have previously talked about submitting a paper about MGT for Journal of Open Source Software. There is a very brief paper snippet in a folder. Could you start looking into what is required for a submission @joachimpoutaraud ?

@joachimpoutaraud
Copy link
Contributor

joachimpoutaraud commented Nov 19, 2023

So I have checked the requirements for submitting a paper for the Journal of Open Source Software and we need the following:

  • The software must be open source as per the OSI definition.
  • The software must have an obvious research application.
  • The paper must not focus on new research results accomplished with the software.
    • The paper (´paper.md´ and BibTeX files, plus any figures) must be hosted in a Git-based repository together with the software (although they may be in a short-lived branch which is never merged with the default).

After making sure of this we need to:

  • Make sure that the software complies with the JOSS review criteria. In particular, the software should be full-featured, well-documented, and contain procedures for checking correctness (for the automated tests procedure we might have a problem because it is not possible to use GitHub Actions for the MGT so far because the actual organization settings does not allow it).
  • Write a short paper in Markdown format using paper.md as file name, including a title, summary, author names, affiliations, and key references. See the example paper to follow the correct format.
  • (Optional) create a metadata file describing the software and include it in the repository. JOSS provide a script that automates the generation of this metadata.

For the paper, it should be between 250-1000 words and include the following:

  • A list of the authors of the software and their affiliations, using the correct format.
  • A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
  • A Statement of need section that clearly illustrates the research purpose of the software and places it in the context of related work.
  • A list of key references, including to other software addressing related needs. Note that the references should include full names of venues, e.g., journals and conferences, not abbreviations only understood in the context of a specific discipline.
  • Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it.
  • Acknowledgement of any financial support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants