playbooks

home / skills / tlabs-xyz / tbtc-v2-performance / global--conventions

global--conventions skill

/.codex/skills/global--conventions

This skill enforces global conventions by applying the Agent OS standard across codebases, ensuring consistency and quality.

npx playbooks add skill tlabs-xyz/tbtc-v2-performance --skill global--conventions

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
369 B
---
name: global--conventions
description: Apply the Agent OS standard for global conventions.
tags: [agent-os, standard, global]
---

# Global Conventions

Use this skill when working on global conventions in this repo.

## Instructions

- Follow the standard in `agent-os/standards/global/conventions.md`.

## References

- `agent-os/standards/global/conventions.md`

Overview

This skill applies the Agent OS standard for global conventions across TypeScript projects. It encodes consistent naming, formatting, and structural conventions to ensure uniform behavior and readability. Use it to automatically align code and documentation with the agreed global rules.

How this skill works

The skill inspects project files and identifies areas that deviate from the Agent OS global conventions, including naming patterns, file organization, and configuration defaults. It reports nonconforming items and provides concrete suggestions or diffs to bring files into compliance. Optionally, it can generate small automated fixes for straightforward violations.

When to use it

  • Onboarding new repositories to ensure they match organization-wide conventions
  • During pull request reviews to flag convention violations early
  • Before releases to ensure consistent public-facing behavior and docs
  • When standardizing multiple projects to reduce cognitive overhead
  • As part of CI checks to enforce automated compliance

Best practices

  • Run the skill early in development and integrate into CI to catch issues quickly
  • Review suggested changes before applying automated fixes for complex files
  • Treat the skill's output as prescriptive for conventions, not as optional style feedback
  • Keep the conventions updated and versioned so projects can migrate smoothly
  • Apply changes incrementally for large repos to limit merge conflicts

Example use cases

  • Check a TypeScript library for naming and export conventions before publishing
  • Enforce consistent file and folder layout across microservices
  • Automate detection of deprecated patterns that violate current global rules
  • Standardize configuration files (lint, build, doc headers) across a mono-repo
  • Integrate with CI to block merges that introduce convention regressions

FAQ

Can the skill automatically fix every violation?

It can automatically fix straightforward, mechanical issues; complex or semantic changes are reported for manual review.

How do I update the conventions the skill enforces?

Update the source standard and version it; then adapt the skill to reference the new rules and run a migration on targets.