Skip to content

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

Description

@kosuri-indu

Hello maintainers @devmotion,

As part of a NumFOCUS Small Development Grant Project Work - JuliaHealth/juliahealth.github.io#66 focused on the JuliaHealth ecosystem, I reviewed FHIRClient.jl to assess documentation, release metadata, and community signals across packages. FHIRClient.jl is an important package within the JuliaHealth ecosystem for interacting with FHIR-based services, 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

Code style & formatting

  • No documented code style or formatter configuration detected
    • .JuliaFormatter.toml file exists but is empty

README completeness

  • Missing or incomplete elements (based on an 8-point audit rubric):
    • No Installation / Getting Started section
    • No Usage / Examples section
    • No Contributing section or link to contribution guidelines
    • No use of lists (bulleted or numbered)
    • No example code blocks
    • Limited use of section headers (fewer than 4 main sections)

Maintenance signals

  • Package appears inactive (no recent releases or merged pull requests)

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 work that has gone into FHIRClient.jl and its contribution 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