lightly-repos-workflow

Guide code contributions to Lightly AG repositories through repo-specific standards and CI checks.

3|Updated Apr 21, 2024
One-click install
npx skills add https://github.com/gabrielfruet/.dotfiles --skill lightly-repos-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lightly-repos-workflow
Source: https://github.com/gabrielfruet/.dotfiles/tree/main/pi/agent/skills/lightly-repos-workflow
Command: npx skills add https://github.com/gabrielfruet/.dotfiles --skill lightly-repos-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the friction of inconsistent code contributions and failed pull requests when working on Lightly AG repositories, ensuring all changes align with repo-specific standards, CI requirements, and registration patterns.

Core Features & Use Cases

  • Cross-repo convention alignment: Provides shared coding, testing, and documentation standards for both lightly-ssl and lightly-train, plus per-repo specific rules for layout, tooling, and feature registration.
  • CI and workflow guardrails: Includes step-by-step guidance for running local pre-commit checks, executing the correct test suites, and monitoring CI without wasting tokens.
  • Feature implementation guidance: Offers tailored instructions for adding transforms, losses, models, methods, configs, docs pages, and examples, including required registration steps, test patterns, and documentation updates for each repo.
  • Use Case: If you are contributing a new self-supervised learning method to lightly-train, this Skill walks you through creating the method directory, registering it in the correct helper, adding focused tests, updating generated docs, and running all required checks before submitting a PR.

Quick Start

Use the lightly-repos-workflow skill to guide your addition of a new transform to the lightly-ssl repository, ensuring you follow all export, test, and documentation requirements before opening a pull request.

Frequently Asked Questions about lightly-repos-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new self-supervised learning method to lightly-train without failing CI checks?

To add a self-supervised learning method to lightly-train, create the method directory, register it in the correct helper, add focused tests, update generated docs, and run local pre-commit checks before submitting a pull request.

What coding standards do I need to follow for lightly-ssl pull requests?

Lightly-ssl pull requests require adherence to repo-specific coding standards, export patterns, test requirements, documentation conventions, and CI gate rules to ensure contributions are mergeable without unnecessary revision cycles.

How do I register a new transform in lightly-ssl before opening a pull request?

Registering a new transform in lightly-ssl requires following specific export patterns, adding focused tests, updating documentation pages, and executing pre-commit checks to satisfy CI gate rules before opening a pull request.

Can I use the same contribution workflow for both lightly-ssl and lightly-train repositories?

Both lightly-ssl and lightly-train share cross-repo conventions for coding, testing, and documentation, but each repo has specific rules for layout, tooling, and feature registration that must be followed.

Why do my pull requests to Lightly AG repositories keep failing CI?

Pull requests to Lightly AG repositories fail CI when changes do not align with repo-specific standards, required registration patterns, test requirements, or CI gate rules, requiring unnecessary revision cycles to fix.

What local checks should I run before submitting a PR to lightly-train?

Before submitting a PR to lightly-train, run local pre-commit checks, execute the correct test suites for your feature, and verify generated docs are updated to avoid CI failures and unnecessary revision cycles.