Mlops collaboration
Guide to prepare MLOps projects for sharing, collaboration, and community engagement.From its SKILL.md
npx -y skills add MLOps-Courses/mlops-coding-skills --skill mlops-collaborationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 20 stars20 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
- runs commandsInstructs the agent to run 4 commands, including `git tag -a vX.Y.Z` and 3 more.
SKILL.md
2.7 KB, 667 tokens by cl100k_base, as published. Nobody here has run it
MLOps Collaboration
Goal
To transform a private project into a public, collaborative resource by establishing Governance (License, Code of Conduct), Documentation (README, Contributing), Standardization (Templates, Workstations), and Release Management.
Prerequisites
- Language: Python
- Platform: GitHub
- Context: Open sourcing or team collaboration.
Instructions
1. Repository Governance
Set the rules of engagement.
- Code of Conduct: Add
CODE_OF_CONDUCT.mdto foster a safe community. - Protection: Protect the
mainbranch (require PRs, status checks). - Review: Automate preliminary reviews with tools like Gemini Code Assist (
.gemini/config.yaml). - Ignore: Comprehensive
.gitignore(exclude secrets, data, venvs).
2. Comprehensive Documentation
Make the project usable and understandable.
- README.md: The landing page (Badges, Hook, Quickstart).
- MkDocs: Use for full documentation sites (API ref, tutorials) when
README.mdgets too long. - CONTRIBUTING.md: Guide for developers (env setup, PR process, testing standards).
- CHANGELOG.md: Generate from Conventional Commits with
git-cliff(replaces Commitizen); commit the rendered file.
3. Standardization & Workstations
Eliminate "it works on my machine".
- Templates: Use
cookiecutterfor scaffolding andcruft updateto keep projects synced. - Workstations: Add
.devcontainer/devcontainer.json.- Define Docker image, extensions, and settings.
- Enable GitHub Codespaces support.
4. Release Management
Ship with confidence.
- Versioning: Follow SemVer (MAJOR.MINOR.PATCH) driven by Conventional Commits.
- Changelog: Generate with
git-clifffrom the commit history (replaces Commitizen/Keep-a-Changelog by hand). - Workflows:
- GitHub Flow: Small teams, continuous delivery (
mainis stable). - Git Flow: Scheduled releases (
develop+releasebranches). - Forking: Open source, distributed contributors.
- GitHub Flow: Small teams, continuous delivery (
- Process: Bump version ->
git-cliffchangelog -> annotatedvX.Y.Ztag (git tag -a vX.Y.Z) ->gh release create vX.Y.Z.
Self-Correction Checklist
- License: Is a
LICENSEfile present? - Readme: Does
README.mdhave installation instructions? - Contributing: Is
CONTRIBUTING.mdclear? - Devcontainer: Does
.devcontainer/devcontainer.jsonexist? - SemVer: Are releases semver-tagged (
vX.Y.Z) viagh release create? - Changelog: Is
CHANGELOG.mdgenerated bygit-clifffrom Conventional Commits?
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.