ui: Instructions file for GitHub Copilot

.github/instructions/uiux-farsi.instructions.md

ui uiux-farsi.instructions.md is an instructions file for GitHub Copilot from farsi-ui/ui. It costs 1,010 tokens per session, scanned A, original, MIT.

A set of GitHub Copilot instructions for building Farsi UI, a Persian-language interface system designed for right-to-left layouts, with React, TypeScript, and Tailwind CSS.

In plain words
What is it for?
Use it when developing or extending Farsi UI components and interfaces.
Why use it?
It gives Copilot project-specific guidance so generated code follows the project's language, layout, and component conventions.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is farsi-ui/ui's own configuration. It tells GitHub Copilot how to work on ui itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything ui configures →

Reuse

Borrowing it

Nothing to install: this file belongs to farsi-ui/ui. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/farsi-ui/ui/main/.github/instructions/uiux-farsi.instructions.md
Clone the repo
git clone --depth 1 https://github.com/farsi-ui/ui

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for ui uiux-farsi.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/farsi-ui/ui/uiux-farsi.svg)](https://agentmods.dev/instructions/farsi-ui/ui/uiux-farsi)
Your own site
<a href="https://agentmods.dev/instructions/farsi-ui/ui/uiux-farsi"><img src="https://agentmods.dev/badge/instructions/farsi-ui/ui/uiux-farsi.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,010 This file is loaded in full into every session.
When invoked 1,010 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01010 $0.01010
Opus 5 $0.00505 $0.00505
Sonnet 5 $0.00202 $0.00202
Haiku 4.5 $0.00101 $0.00101

Measured 5d ago against content hash 50fb91166df9, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

ui uiux-farsi.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/uiux-farsi.instructions.md · 169 lines

How it starts

The opening of the file, as written. The whole thing — 169 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Overview

These instructions guide GitHub Copilot to assist in developing Farsi UI, an open-source, RTL-first UI/UX design system tailored for Persian (Farsi) applications.

Project Context

Farsi UI is an RTL-first, Persian-focused adaptation of shadcn/ui.

It is not a packaged component library or registered design system. It is a set of copy-and-own component patterns intended to be customized, extended, and fully owned by the product team.

Key principles:

  • RTL is the default, not a variant
  • Persian language and typography are first-class
  • Calm, modern, production-ready UI
  • No lock-in, no hidden registry, no forced theming
  • Same philosophy and mental model as shadcn/ui

Assume the technology stack is:

  • React + TypeScript
  • Tailwind CSS
  • Radix UI (for primitives and accessibility)

General Copilot Behavior

When generating output, Copilot must:

  • Optimize for RTL-first layouts and interactions
  • Treat components as starting points, not finished abstractions
  • Prefer clarity and explicitness over clever abstractions
  • Produce code that is easy to copy, rename, refactor, and extend
  • Align with shadcn/ui conventions and structure
  • Avoid introducing unnecessary dependencies, registries, or frameworks

Visual & UX Design Guidelines

Visual Design (RTL-First)

  • Establish clear visual hierarchy for RTL reading flow
  • Use spacing, alignment, and layout that feel natural in RTL
  • Treat Persian typography as first-class (font choice, numerals, spacing)
  • Ask for brand or typography guidelines if not provided
  • Ensure WCAG 2.1 AA color contrast compliance
  • Maintain consistency across copied components

Interaction Design

  • Design interactions that feel native to RTL (directional icons, motion, alignment)
  • Use familiar patterns consistent with shadcn/ui
  • Place calls-to-action appropriately for RTL emphasis
  • Use animation sparingly and purposefully

Accessibility Requirements

Copilot must ensure:

Read the full file on GitHub · 169 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 169 lines · 1,010 tokens per session scan A 50fb91166df9

Subscribe to this mod's changes

ui uiux-farsi.instructions.md is an instructions file published in the GitHub repository farsi-ui/ui (11 stars, last pushed 1mo ago), licensed MIT. It adds 1,010 tokens to every session, about $0.0051 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-02.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens