GitHub Repo Best Practices FAQs

Question 1

When should I use this skill?

Accepted Answer

Use this skill whenever you are starting a new GitHub project, migrating a legacy repository to modern standards, or performing routine maintenance. It is applicable to software code, LinkML schemas, ontologies, curated content, and data analysis projects.

Question 2

Does this skill work for non-code repositories?

Accepted Answer

Yes. This skill is specifically designed to handle non-code projects including ontology development (via the ODK), LinkML data schemas, and documentation-heavy repositories, ensuring they meet the same rigorous engineering standards as software projects.

Question 3

How does this skill improve testing and documentation?

Accepted Answer

It mandates Test-Driven Development (TDD) using pytest, doctests for human-readable verification, and vcrpy for API mocking. For documentation, it implements the Diátaxis framework via mkdocs or Sphinx, ensuring a structured balance of tutorials, how-tos, references, and explanations.

Question 4

Which development tools does this skill prioritize?

Accepted Answer

The skill enforces a modern Python stack featuring 'uv' for dependency management, 'ruff' for linting, and 'mypy' for strict typing. It also favors 'Typer' or 'Click' for CLI development and 'just' or 'make' for build automation and task running.

Question 5

What does the GitHub Repo Best Practices skill do?

Accepted Answer

This skill provides Claude with specific instructions to create and maintain high-quality repositories following BBOP (Berkeley Bioinformatics Open-source Projects) standards. It automates project bootstrapping using Copier templates for Python, LinkML, and ontologies, ensuring consistency across all code and data projects.

GitHub Repo Best Practices

GitHub Repo Best Practices

Características Principales

Casos de Uso

Características Principales

Casos de Uso