You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+17-40Lines changed: 17 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
applyTo: "**"
3
3
---
4
4
5
-
# OUDS Web — Project Context
5
+
# OUDS Web
6
6
7
-
**OUDS Web** (Orange Unified Design System — Web) is a multi-brand design system built as a fork of Bootstrap 5.3.6. It serves 3 brands (Orange, Sosh, Orange Compact) from a single codebase where only CSS tokens differ per brand — JavaScript is fully shared.
7
+
**OUDS Web** (Orange Unified Design System — Web) is a multi-brand design system built as a fork of Bootstrap 5.3.6. It serves 3 brands (Orange, Sosh, Orange Compact) from a single codebase — only CSS tokens differ per brand, JavaScript is fully shared.
These rules are non-negotiable and apply to every contribution:
24
-
25
-
1.**Use tokens, not hardcoded values** — colors, spacing, dimensions all come from the OUDS token system.
26
-
2.**Use mixins for `border-radius` and `transition`** — direct CSS properties are forbidden by Stylelint.
27
-
3.**Auto-generated token files are read-only** — never edit `_raw.scss`, `_semantic.scss`, `_component.scss`, or `_*-custom-props.scss`. Only `_composite.scss` is hand-editable.
28
-
4.**Never commit `dist/`** — build artifacts are generated in CI.
29
-
5.**JavaScript lives in `js/src/` only** — never in `packages/<brand>/`.
30
-
6.**Colors use CSS custom properties** — `var(--#{$prefix}color-*)` enables runtime dark mode switching.
31
-
7.**Accessibility is mandatory** — visible `:focus-visible`, ARIA attributes on all interactive elements, `.visually-hidden` for SR content.
32
-
33
-
## Scoped Instructions
34
-
35
-
Detailed conventions are loaded automatically based on the files you're working on. They live in `.github/instructions/`:
36
-
37
-
-`scss.instructions.md` — SCSS conventions and patterns
38
-
-`javascript.instructions.md` — JS conventions
39
-
-`html-accessibility.instructions.md` — HTML structure and WCAG compliance
For in-depth architecture knowledge, read the reference docs in `.github/instructions/references/`:
55
-
56
-
-`token-architecture.md` — Full token pipeline and layer hierarchy
57
-
-`glossary.md` — 154 project-specific terms
58
-
-`project-map.md` — File structure, npm scripts, CI/CD jobs
21
+
## Skills
22
+
23
+
This project provides specialized skills in `.github/skills/`. Invoke them when relevant — they contain detailed conventions, workflows, and reference material:
These 7 rules apply to every file in OUDS Web. They are the minimum safety net — always enforced regardless of which skills are loaded.
8
+
9
+
1.**Tokens over hardcoding** — Never use hardcoded colors (`#ff7900`), spacing (`16px`), or dimensions. Use `$ouds-*` tokens or `var(--#{$prefix}color-*)`.
10
+
11
+
2.**Mixins for border-radius and transition** — Direct properties are Stylelint violations. Use `@include border-radius()` and `@include transition()`.
12
+
13
+
3.**Auto-generated token files are read-only** — Never edit `_raw.scss`, `_semantic.scss`, `_component.scss`, or `_*-custom-props.scss`. Only `_composite.scss` is hand-editable.
14
+
15
+
4.**Never commit dist/** — Build artifacts are generated in CI.
16
+
17
+
5.**JS in js/src/ only** — Never put JavaScript in `packages/<brand>/`. JS is shared across all brands.
18
+
19
+
6.**Colors via CSS custom properties** — Use `var(--#{$prefix}color-*)` for all colors. This enables dark mode switching at runtime.
20
+
21
+
7.**Accessibility is mandatory** — Every interactive element needs: `@include focus-visible()`, correct ARIA attributes, `.visually-hidden` (never `display: none`) for SR content, 44×44px touch targets.
0 commit comments