Skip to content

Adding AI steering docs to the FDC3 repo#1867

Open
kriswest wants to merge 2 commits intomainfrom
AI-steering-docs
Open

Adding AI steering docs to the FDC3 repo#1867
kriswest wants to merge 2 commits intomainfrom
AI-steering-docs

Conversation

@kriswest
Copy link
Copy Markdown
Contributor

Describe your change

The FDC3 repo is complex and the relationship between different packages and the FDC3 documentation is not always immediately obvious. This PR adds AI steering docs (AGENTS.md, plus Amazon Q, Krio and Gitlab Duo specific files referencing it) to help guide agents that are used to prepare contributions. Some specific guidance is given on the relationship between packages, and where the relevant documentation resides, to encourage agents to create better contributions.

This is a first pass at generating guidance based on recent work I've been doing. There is much more that could be added - but I believe this is a worthwhile firs pass.

Related Issue

resolves #1866

Contributor License Agreement

  • I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

  • Issue: If a change was made to the FDC3 Standard, was an issue linked above?
  • CHANGELOG: Is a CHANGELOG.md entry included?

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 24, 2026

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit b1d33cc
🔍 Latest deploy log https://app.netlify.com/projects/fdc3/deploys/69eb7fcf12870c0008f7dc93

@kriswest kriswest marked this pull request as ready for review April 24, 2026 14:16
@kriswest kriswest requested a review from a team as a code owner April 24, 2026 14:16
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.61%. Comparing base (cc84068) to head (b1d33cc).

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #1867    +/-   ##
========================================
  Coverage   95.61%   95.61%            
========================================
  Files          69       69            
  Lines        4680     4680            
  Branches      772      912   +140     
========================================
  Hits         4475     4475            
  Misses        205      205            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AI steering docs to the FDC3 repo

2 participants