Contributing

Contributing

Help improve Token Optimizer by adding new patterns, templates, and examples. High-quality contributions get merged and credited in the CHANGELOG.

---

Before You Contribute

1. Star the repository — required by license
2. Read SKILL.md — understand existing techniques before adding new ones
3. Check open issues — your idea may already be in progress

---

What We Accept

High Priority

• New compression patterns with measured token savings
• Additional system prompt templates for untested domains
• Before/after examples with real token counts
• Bug fixes in existing reference files

Medium Priority

• New output format templates
• Edge case handling in context management
• Performance benchmarks

Not Accepted

• Unverified token savings claims (evidence required)
• Content in any language other than English
• Patterns already covered in compression-patterns.md
• Changes that break skill language consistency

---

How to Contribute

Step 1 — Fork and Branch

git clone https://github.com/samibajwaisking/token-optimizer-skill
cd token-optimizer-skill
git checkout -b feature/your-improvement-name

Branch naming:

• feature/add-[thing] — new content
• fix/[what-was-wrong] — corrections
• improve/[what-improved] — enhancements

---

Step 2 — Make Your Changes

For new compression patterns:

• Add to correct category in references/compression-patterns.md
• Format: | Verbose phrase (N tokens) | Compressed form | Savings % |
• Include measured token counts

For new system prompt templates:

• Add to references/system-prompt-templates.md
• Must be under 200 tokens
• Must include: role + rules + default format
• Test with at least 3 prompts before submitting

For new before/after examples:

• Add to examples/before-after.md
• Must include: before (with token count), after (with token count), savings %, quality note

Language rule: English only. No exceptions.

---

Step 3 — Test

Before submitting:

• Load modified SKILL.md into Claude and verify it triggers correctly
• Run at least 3 test prompts using any new patterns
• Confirm token savings are real measurements, not estimates
• Check no existing content was accidentally modified

---

Step 4 — Submit Pull Request

git add .
git commit -m "feat: brief description of change"
git push origin feature/your-improvement-name

Commit types:

• feat: — new content
• fix: — correction
• improve: — enhancement
• docs: — documentation only

---

Recognition

All accepted contributors are credited in CHANGELOG.md under the relevant version. Significant contributions may be featured in the README contributors section.

---

Questions?

Open an issue or contact via samioutic.com