Skip to content

feat(ai): Add agent.md to project#669

Open
AhmedAmineZr wants to merge 4 commits into
prepare-new-version-2.0.0from
668-publish-an-agentsmd-file
Open

feat(ai): Add agent.md to project#669
AhmedAmineZr wants to merge 4 commits into
prepare-new-version-2.0.0from
668-publish-an-agentsmd-file

Conversation

@AhmedAmineZr

@AhmedAmineZr AhmedAmineZr commented Apr 18, 2026

Copy link
Copy Markdown
Member

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Description

Motivation & Context

Types of change

  • Bug fix (non-breaking which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Previews

Checklist

Contribution

Accessibility

  • (NA) My change follows accessibility good practices

Design

  • (NA) My change respects the design guidelines of Orange Unified Design System

Development

  • (NA) My change follows the developer guide
  • (NA) I have added unit tests to cover my changes (optional)

Documentation

  • (NA) My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

  • (NA) Manually test (dark mode, RTL, landscape display, tablet)
  • Documentation has been updated if relevant
  • (NA) Design review
  • (NA) A11y review
  • (NA) Internal files have been updated if relevant (THIRD_PARTY, NOTICE)
  • changelog.md has been updated respecting keep a changelog rules and referencing the issue

@AhmedAmineZr AhmedAmineZr requested a review from nouha06 April 18, 2026 16:08
@AhmedAmineZr AhmedAmineZr self-assigned this Apr 18, 2026
@AhmedAmineZr AhmedAmineZr linked an issue Apr 18, 2026 that may be closed by this pull request
@AhmedAmineZr AhmedAmineZr force-pushed the 668-publish-an-agentsmd-file branch 4 times, most recently from ddfc6ab to b8a6854 Compare April 21, 2026 17:31
@AhmedAmineZr AhmedAmineZr force-pushed the 668-publish-an-agentsmd-file branch from b8a6854 to 13ade20 Compare April 28, 2026 09:33
@AhmedAmineZr AhmedAmineZr changed the base branch from develop to prepare-new-version-2.0.0 June 2, 2026 15:02
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

📖 Documentation preview deployed!

🔗 https://flutter.unified-design-system.orange.com/prPreview/669/

github-actions Bot pushed a commit that referenced this pull request Jun 2, 2026
@AhmedAmineZr AhmedAmineZr force-pushed the 668-publish-an-agentsmd-file branch from 2a3d2f9 to 27d2dbf Compare June 3, 2026 13:19
github-actions Bot pushed a commit that referenced this pull request Jun 3, 2026
@pylapp pylapp requested a review from Copilot June 3, 2026 15:16

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a set of repository-local AI agent guidance documents for the OUDS Flutter workspace, including an agent entrypoint (AGENTS.md), GitHub Copilot repository instructions, and a set of OUDS domain “skills” documents intended to guide future assistance on framework usage, vocabulary, accessibility, migration, and Figma-to-Flutter token mapping.

Changes:

  • Add a root-level AI agent guide (AGENTS.md) describing the workspace, key files, and critical rules.
  • Add .github/copilot-instructions.md with build, review, and accessibility guidance tailored to this repo.
  • Add OUDS skill documents under skills/ to provide structured, task-specific guidance (vocabulary, framework usage, migration, accessibility, token mapping).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
AGENTS.md Adds an AI agent guide describing the project, key files, and critical rules.
.github/copilot-instructions.md Adds repository-specific Copilot instructions (architecture, build/test commands, review checklist).
skills/ouds-vocabulary/SKILL.md Adds a glossary for OUDS-specific terminology and when to load related skills.
skills/ouds-framework-usage/SKILL.md Adds usage guidance for OUDS Flutter (setup, imports, themes, components, verification).
skills/ouds-figma-to-flutter/SKILL.md Adds guidance for mapping Figma token families to Dart token layers and names.
skills/ouds-migration-guide/SKILL.md Adds adoption/migration guidance (Material/custom → OUDS, and version-to-version migrations).
skills/ouds-accessibility/SKILL.md Adds accessibility rules and patterns for OUDS components and custom widgets.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread skills/ouds-framework-usage/SKILL.md Outdated
Comment thread skills/ouds-framework-usage/SKILL.md Outdated
Comment thread skills/ouds-flutter-framework-usage/SKILL.md
Comment thread skills/ouds-migration-guide/SKILL.md Outdated
@AhmedAmineZr AhmedAmineZr force-pushed the 668-publish-an-agentsmd-file branch from 3de33f6 to c6e37f7 Compare June 4, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish an AGENTS.md file

3 participants