Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (33 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 2.18 KB
Raw

Contributing

Thanks for helping improve the UAE PASS Agent Skill. Issues and pull requests are welcome.

Ground rules

  • Accuracy first. This skill is consolidated from the public docs at docs.uaepass.ae and the official sample apps. Don't invent endpoints, parameters, or behaviour — cite the source page. Each reference starts with a **Source:** line; keep it accurate. See MAINTAINING.md for the source map and refresh workflow.
  • idshub is authoritative. Use the current stg-id.uaepass.ae/idshub/... / id.uaepass.ae/idshub/... endpoints. The 2020 PDFs' trustedx-* URLs are legacy — never add them as live values; only mention them as "deprecated".
  • Respect progressive disclosure. SKILL.md stays lean (routing + web quick-start + gotchas). Detail lives in references/, one platform per file — web work must not pull in mobile/Flutter/RN context, and vice-versa. New platform? Add a new references/<platform>-integration.md and a row in SKILL.md §1.
  • Mark unofficial things. Community plugins (Flutter, React Native) are not official UAE PASS SDKs — label them clearly and pin the version you cite.
  • No secrets. Only the public staging sandbox creds (sandbox_stage) may appear. Never commit a real client_secret, token, or .env.

Making a change

  1. Edit the relevant file under skills/uaepass/ (and SKILL.md if routing changes).
  2. If it's a doc-driven update, run scripts/update-from-docs.sh and diff against the mirror.
  3. Validate discovery and do a smoke install: 
    npx skills add ./ --list
npx skills add ./ --skill uaepass --agent claude-code   # then try it in the agent
  4. Keep commits small and focused. Conventional-commit style is appreciated (docs(ios): …, feat(skill): …, fix(web): …).
  5. Open a PR describing what changed and which source page(s) back it.

Scope

In scope: anything that helps an agent integrate UAE PASS correctly (auth across platforms, signing, eSeal, data sharing, facial biometric, onboarding, troubleshooting). Out of scope: storing real credentials, or anything that isn't backed by an official/public source.