Skip to content

Conversation

@kvrigor
Copy link
Member

@kvrigor kvrigor commented Oct 10, 2025

TODO. This PR must meet the JOSS documentation review criteria:

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

@AGonzalezNicolas AGonzalezNicolas marked this pull request as ready for review October 10, 2025 08:44
@kvrigor kvrigor marked this pull request as draft October 10, 2025 08:58
@kvrigor kvrigor linked an issue Oct 10, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Detailed Description of eCLM

3 participants