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 paper #172

Open
20 tasks
Rykath opened this issue Oct 17, 2022 · 0 comments
Open
20 tasks

JOSS paper #172

Rykath opened this issue Oct 17, 2022 · 0 comments
Labels
JOSS Related to the paper for The Journal of Open Source Software project

Comments

@Rykath
Copy link
Collaborator

Rykath commented Oct 17, 2022

Submit a paper to The Journal of Open Source Software (JOSS).

Setup

  • example paper
  • metadata
  • bibliography
  • auto-compile with Open Journal GitHub Action

Criteria for the paper

  • A list of the authors of the software and their affiliations.
  • A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
  • A clear statement of need that illustrates the purpose of the software.
  • A description of how this software compares to other commonly-used packages in this research area.
  • Mentions (if applicable) of any ongoing research projects using the software or recent scholarly publications enabled by it.
  • A list of key references including a link to the software archive.

Criteria for the software

  • software license
  • substantial scholarly effort
  • documentation
    • statement of need
    • installation instructions
    • example usage
    • API documentation
    • community guidelines
  • functionality
  • tests
@Rykath Rykath added project JOSS Related to the paper for The Journal of Open Source Software labels Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JOSS Related to the paper for The Journal of Open Source Software project
Projects
None yet
Development

No branches or pull requests

1 participant