JuliaHealth / JuliaHealth/BioMedQuery.jl

Audit follow-up: Documentation & Community Metadata Improvements

Open
#75 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
19
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Hello @DilumAluthge,

As part of a NumFOCUS Small Development Grant Project Work - https://github.com/JuliaHealth/juliahealth.github.io/issues/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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing README and repository metadata against the audit checklist, including the proposed CONTRIBUTING.md, CODE_OF_CONDUCT.md, and .JuliaFormatter.toml files. First determine which suggestions the maintainers want to pursue; completion would mean the selected documentation, community files, formatting configuration, and usage examples are added or updated consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.