Skip to content

Commit 6119d00

Browse files
truman-t3truman-t3
committed
chore: add MIT LICENSE, sync skill name to slug, rename cursor rule, add CHANGELOG & CONTRIBUTING
- Add LICENSE (MIT) so the declared license has a real file - SKILL.md name: tinted-ui-tokens -> tinted-ui-tokens-skills (match repo slug) - Rename Cursor rule tinted-ui-tokens.mdc -> tinted-ui-tokens-skills.mdc - Add CHANGELOG.md and CONTRIBUTING.md - Local validator passes
1 parent ebb9a28 commit 6119d00

7 files changed

Lines changed: 96 additions & 6 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented here. The format is based on
4+
[Keep a Changelog](https://keepachangelog.com/), and this project adheres to
5+
[Semantic Versioning](https://semver.org/).
6+
7+
## [1.1.0] - 2026-07-18
8+
9+
### Added
10+
- `LICENSE` (MIT) — the repository now ships an explicit license file (README
11+
already declared MIT; the file was missing).
12+
- `CHANGELOG.md` — release history.
13+
- `CONTRIBUTING.md` — contribution guidelines.
14+
15+
### Changed
16+
- `SKILL.md` `name:` synced from `tinted-ui-tokens` to `tinted-ui-tokens-skills`
17+
so it matches the repository slug.
18+
- Cursor rule file renamed `tinted-ui-tokens.mdc` → `tinted-ui-tokens-skills.mdc`
19+
to match the slug; the Cursor README references were updated accordingly.
20+
21+
## [1.0.0] - 2026-07-11
22+
23+
### Added
24+
- Initial release: brand-agnostic tinted design-token generator
25+
(`scripts/generate_tokens.py`).
26+
- `SKILL.md` (WorkBuddy / Claude Code) plus `INSTRUCTIONS.md` (agent-neutral
27+
core instructions).
28+
- Cross-agent wiring docs under `agents/` for Claude Code, Cursor,
29+
OpenAI Codex, Cline, Aider, WindSurf, GitHub Copilot, and Gemini CLI.
30+
- `references/principles.md` distilling the essay 《你的UI廉价，错在颜色》.
31+
- GitHub Actions CI (`validate.yml`) running frontmatter + smoke + semantic
32+
sanity checks.
33+
- Bilingual README with a cross-agent compatibility table.

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing · 贡献指南
2+
3+
Thanks for wanting to improve **tinted-ui-tokens-skills**! This document is short
4+
on purpose.
5+
6+
## How to contribute · 如何贡献
7+
8+
1. **Open an issue first** for anything non-trivial (new agent support, algorithm
9+
change, doc fix) so we can align before writing code.
10+
2. **Fork & branch** from `main`: `git checkout -b fix/short-description`.
11+
3. **Keep the skill agent-neutral.** The engine (`scripts/generate_tokens.py`)
12+
must stay identical across agents. Agent-specific differences live only in
13+
`agents/<agent>/` (rule-file location, install snippet).
14+
4. **Run the local validator** before pushing:
15+
16+
```bash
17+
python scripts/validate_skill.py
18+
```
19+
20+
It replicates the CI checks (frontmatter validity + 3-color smoke test +
21+
semantic-color sanity). CI must stay green.
22+
23+
5. **Update docs together:** if you change the slug / skill name, update every
24+
reference in `SKILL.md`, `README.md`, `INSTRUCTIONS.md`, and all
25+
`agents/*/README.md`. Keep filenames and the repo slug in sync.
26+
27+
## Naming convention · 命名规范
28+
29+
- Repo slug, `SKILL.md` `name:`, and any bundled rule-file names must all share
30+
the same `tinted-ui-tokens-skills` base (hyphen-case). Don't let them drift.
31+
- Keep `README.md` bilingual (中文 + English).
32+
33+
## Releasing · 发版
34+
35+
Maintainers bump the version in `CHANGELOG.md`, tag `vX.Y.Z` on `main`, and create
36+
a GitHub Release. The license stays MIT.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 truman-t3
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: tinted-ui-tokens
2+
name: tinted-ui-tokens-skills
33
display_name: 品牌色 UI 设计 Token skills
44
description: "Generates a complete, production-ready design-token system from a single brand color, where every neutral surface (backgrounds, borders, text, shadows, semantic colors, gradients, icons, dark mode) carries a few percent of the brand's temperature instead of using pure neutral colors. Use when a user asks to generate, build, or design UI color tokens, a design system, CSS variables, a tinted color palette, or a branded theme from a brand color or hex, or wants to make an existing UI look more premium by fixing flat neutral colors. Trigger phrases include 给我生成一套设计Token, 用这个品牌色出一套配色, UI颜色太廉价了, 生成染色中性色系统, build a design system from #XXXXXX, tinted neutral palette."
55
agent_created: true

‎agents/cursor/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# tinted-ui-tokens-skills on Cursor
22

33
Cursor reads rules from `.cursor/rules/` (project) or `~/.cursor/rules/` (global).
4-
A ready-to-use rule file is provided: [`tinted-ui-tokens.mdc`](tinted-ui-tokens.mdc).
4+
A ready-to-use rule file is provided: [`tinted-ui-tokens-skills.mdc`](tinted-ui-tokens-skills.mdc).
55

66
## Install · 安装
77

88
Copy the rule into your rules directory:
99

1010
```bash
1111
# project scope
12-
cp tinted-ui-tokens.mdc <your-project>/.cursor/rules/
12+
cp tinted-ui-tokens-skills.mdc <your-project>/.cursor/rules/
1313

1414
# or global scope
15-
cp tinted-ui-tokens.mdc ~/.cursor/rules/
15+
cp tinted-ui-tokens-skills.mdc ~/.cursor/rules/
1616
```
1717

1818
Also make the engine available — clone the repo or copy `scripts/generate_tokens.py`

agents/cursor/tinted-ui-tokens.mdc renamed to agents/cursor/tinted-ui-tokens-skills.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ alwaysApply: false
88

99
When the user wants to generate UI color tokens, a design system, CSS variables,
1010
or a branded theme from a brand color (or wants to fix a "cheap-looking" flat UI),
11-
follow the instructions in `INSTRUCTIONS.md` of the tinted-ui-tokens repo:
11+
follow the instructions in `INSTRUCTIONS.md` of the tinted-ui-tokens-skills repo:
1212

1313
1. Collect the brand hex (ask if missing).
1414
2. Run `scripts/generate_tokens.py --brand <hex> --name <name> --out <dir>`.

‎scripts/validate_skill.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python3
22
"""
3-
Self-contained skill validator for tinted-ui-tokens.
3+
Self-contained skill validator for tinted-ui-tokens-skills.
44
55
Replicates the core frontmatter checks used by WorkBuddy's skill-creator
66
``quick_validate`` so that "passes CI" stays equivalent to "passes

0 commit comments

Comments
 (0)