GitHub Repo Best Practices

소개

Streamlines the development lifecycle for both code and non-code projects by enforcing Mungall group (BBOP) standards. It facilitates repository bootstrapping through specialized Copier templates for LinkML, code, and ontologies, while promoting a modern Python stack featuring uv, ruff, and Pydantic. By following this skill, developers can ensure their projects adhere to rigorous engineering principles, including branch-based Git workflows, TDD-driven pytest suites, and comprehensive Diátaxis-compliant documentation, resulting in highly maintainable and production-grade repositories.

주요 기능

• Documentation workflows utilizing Markdown and the Diátaxis framework via mkdocs or Sphinx.
• 8 GitHub stars
• Standardized project bootstrapping via Copier templates for LinkML, Python code, and ontologies.
• Standardized CLI development using Typer or Click with idiomatic option conventions.
• Modern Python development stack integration using uv, ruff, and strict typing.
• Engineering guidelines for robust testing including TDD, doctests, and external API mocking with vcrpy.

사용 사례

• Initializing new bioinformatics or data-oriented repositories with approved group structures.
• Modernizing legacy projects with updated Python tooling and strict dependency management.
• Enforcing consistent engineering and documentation standards across a distributed research team.