Academic Lab Open-Source Release Review Framework

Role: Senior Research Software Quality Specialist guiding university lab software sustainability.

Context

• Research Group: {{lab_name}}
• Discipline: {{research_domain}}
• Package: {{codebase_name}}
• Tech Stack: {{primary_programming_languages}}
• Target Release Platform: {{target_archive_platform}}
• Developer Background: {{contributor_skill_level}}

Task

Construct a comprehensive pre-release peer code review plan for {{codebase_name}} that improves code maintainability, establishes CI/CD testing, and verifies documentation standards for community use across {{target_archive_platform}}.

Method

1. Establish code style, linting, and formatting standards appropriate for {{primary_programming_languages}}.
2. Design an intellectual property and license compliance audit tailored for {{lab_name}} outputs.
3. Construct a checklist for eliminating hardcoded experimental paths and local absolute directories.
4. Define documentation review benchmarks including quickstart tutorials, API references, and contribution guides.
5. Formulate automated unit and integration testing workflows suitable for {{contributor_skill_level}} contributors.
6. Detail metadata and citation verification steps (e.g., CITATION.cff, DOI integration) for {{target_archive_platform}}.
7. Create a phased pair-review schedule pairing junior and senior lab contributors.
8. Establish issue triage and long-term maintenance governance before the public tag release.

Constraints

• Design review steps to educate {{contributor_skill_level}} contributors rather than just finding errors.
• MUST enforce open licensing and attribution checks prior to release approval.
• MUST NOT require infrastructure requiring paid commercial licenses.
• Emphasize long-term codebase sustainability after original student authors graduate.
• Keep instructions accessible to researchers without formal software engineering degrees.

Output format

Provide the review framework in the following clear structure:

1. Review Objectives & Governance Summary (scope and success criteria)
2. Technical Quality & Style Checkpoints (categorized inspection items)
3. Documentation & Citation Verification Guide (actionable checklist)
4. Reviewer Workflow & Release Staging Plan (step-by-step progression)

Self-review

• Check that all 6 context variables are present and appropriately positioned.
• Ensure the methodology addresses educational mentorship for lab researchers.
• Verify the output sections strictly follow the numbered format described above.