agentleFS
TangleMLTangleML/tangle-ui/.claude/skills/open-source/SKILL.md

open-source

Skill104 starsChanged 3 days agoApache-2.0View on GitHub

Open source guidelines for Tangle-UI. Use when writing user-facing text, UI copy, error messages, banners, documentation, or any content visible to users.

We split this skill into the rules it gives an agent

8 rules. 0 are common, 8 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Company-specific references: No mentions of Shopify, internal teams, internal tools, or internal infrastructure

    line 12
  2. Distinctive:

    Internal URLs: No links to internal dashboards, wikis, Slack channels, or internal services

    line 13
  3. Distinctive:

    Infrastructure assumptions: No references to specific cloud providers, internal clusters, or internal deployment targets as if they're the …

    line 14
  4. Distinctive:

    Internal warnings or notices: No banners, alerts, or messages about internal systems, outages, or company-specific policies

    line 15
  5. Distinctive:

    Write generic, vendor-neutral copy that applies to any user

    line 20
  6. Distinctive:

    Use general cloud/ML terminology (e.g., "your backend" not "the Shopify backend")

    line 22
  7. Distinctive:

    If Shopify-specific configuration or documentation is needed, it belongs in:

    line 42
  8. Distinctive:

    Never put it in the frontend source code, UI copy, or committed configuration files.

    line 48

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Open Source Guidelines

Tangle-UI is an open source project. All code, UI copy, and documentation must be vendor-neutral and usable by anyone — not just Shopify employees.

Do Not Include

  • Company-specific references: No mentions of Shopify, internal teams, internal tools, or internal infrastructure
  • Internal URLs: No links to internal dashboards, wikis, Slack channels, or internal services
  • Infrastructure assumptions: No references to specific cloud providers, internal clusters, or internal deployment targets as if they're the only option
  • Internal warnings or notices: No banners, alerts, or messages about internal systems, outages, or company-specific policies
  • Employee-specific language: No "talk to the platform team", "file a ticket in [internal tool]", or similar

What to Do Instead

  • Write generic, vendor-neutral copy that applies to any user
  • Reference configurable settings rather than hardcoded internal values (e.g., backend URL is configurable, not pointed at an internal endpoint)
  • Use general cloud/ML terminology (e.g., "your backend" not "the Shopify backend")
  • For infrastructure-specific behavior, make it configurable via environment variables or settings, not hardcoded
  • Error messages should guide users to general troubleshooting steps, not internal escalation paths

Examples

// Bad — Shopify-specific
"Contact the ML Platform team on #ml-platform-support for help."
"This pipeline requires access to the Shopify GCP project."
"Warning: Shopify infrastructure maintenance scheduled."

// Good — vendor-neutral
"Check your backend connection settings."
"This pipeline requires a configured backend endpoint."
"Unable to connect to the backend. Verify your settings."

When Internal Context Is Needed

If Shopify-specific configuration or documentation is needed, it belongs in:

  • Environment variables (configured at deployment, not in code)
  • External documentation (internal wikis, not in-app)
  • The backend (server-side configuration, not frontend hardcoding)

Never put it in the frontend source code, UI copy, or committed configuration files.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.