Skip to content

Audit follow-up: Documentation & Community Metadata Improvements #18

@kosuri-indu

Description

@kosuri-indu

Hello maintainers @AdamWysokinski,

As part of a NumFOCUS Small Development Grant Project Work focused on the JuliaHealth ecosystem, I reviewed NeuroAnalyzer.jl to assess documentation, release metadata, and community signals across packages. NeuroAnalyzer.jl appears to be an actively maintained and evolving package, and the notes below are purely informational, surfaced through a standardized ecosystem audit.

Findings from the audit

Community & governance

  • No CONTRIBUTING.md file detected
  • No CODE_OF_CONDUCT.md file detected

Documentation & discoverability

  • Documentation is present (docs/ directory detected), but:
    • No hosted documentation (GitHub Pages) detected
    • No Documenter.jl configuration detected

CI & quality signals

  • No code coverage reporting detected

README completeness

  • Missing or incomplete elements (based on an 8-point audit rubric):
    • No Installation / Getting Started as in how to download the pkg section
    • No Contributing section or link to contribution guidelines

References (JuliaHealth templates)

Please let me know what you would prefer:

  • I can help by contributing some of the straightforward items, and leave the rest to be handled by the maintainers, or
  • You would prefer to handle everything yourselves

Thanks again for maintaining and contributing NeuroAnalyzer.jl to the JuliaHealth ecosystem!

~ indu

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions