Skip to content

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

@kosuri-indu

Description

@kosuri-indu

Hello @DilumAluthge,

As part of a NumFOCUS Small Development Grant Project Work - JuliaHealth/juliahealth.github.io#66 focused on the JuliaHealth ecosystem, I reviewed BioMedQuery.jl to assess documentation, release metadata, and community signals across packages. BioMedQuery.jl is a historically useful package within the JuliaHealth ecosystem, 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

CI & quality signals

  • No code coverage reporting detected

Code style & formatting

  • No documented code style or formatter configuration detected
    • Consider adding a .JuliaFormatter.toml file to document and standardize formatting

README completeness

  • Missing or incomplete elements:
    • No Usage / Examples section describing how to use the package after installation
    • No Contributing section or link to contribution guidelines

Maintenance signals

  • Package appears inactive (no recent releases or commits for an extended period)

References (JuliaHealth templates)

These are all suggestions, shared in case you are interested in revisiting or revitalizing the package in the future.

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

Thank you again for the long-standing impact BioMedQuery.jl has had in the JuliaHealth ecosystem.

~ indu

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions