Add AI agent rules #2772
Add AI agent rules #2772
Conversation
![azure-pipelines[bot]](https://avatars.githubusercontent.com/in/9426?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for AI coding assistants (Claude, GitHub Copilot, and Cursor) to help them understand and work with the MSAL iOS/macOS authentication library codebase. The documentation provides repository structure, coding guidelines, API usage examples, and tenant configuration instructions.
Key Changes
- Added AI assistant instruction files for Claude, Copilot, and Cursor with identical repository guidance
- Created detailed code style guidelines for Objective-C development
- Added feature gating documentation using MSIDFlightManager
- Included step-by-step tenant configuration guides for both Workforce and External tenants
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| CLAUDE.md | Claude AI assistant instructions covering repository structure, architecture, testing, and coding guidelines |
| AGENTS.md | GitHub Copilot instructions (identical to CLAUDE.md) for repository navigation and development |
| .cursor/rules/ruler_cursor_instructions.mdc | Cursor IDE instructions (identical to CLAUDE.md) for working with the codebase |
| .clinerules/AGENTS.md | High-level guidance on application creation options and references to detailed documentation |
| .clinerules/05-feature-gating.md | Comprehensive guide for implementing feature flags using MSIDFlightManager |
| .clinerules/04-Code-style-guidelines.md | Detailed Objective-C coding standards and best practices for the repository |
| .clinerules/03-MSAL-API-usage.md | Code examples for common MSAL authentication patterns in Swift and Objective-C |
| .clinerules/02-Workforce-tenant-configuration.md | Step-by-step instructions for configuring Workforce tenant applications |
| .clinerules/01-External-tenant-configuration.md | Step-by-step instructions for configuring External tenant applications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Proposed changes
Add rules for AI agents: cline, GitHub Copilot, claude & cursor.
This pull request introduces comprehensive onboarding and guidance documentation for agents and developers working with the MSAL library for iOS and macOS. The new documentation covers application creation, tenant configuration, MSAL API usage (with code samples), and project-specific coding and feature flag guidelines. These additions are designed to standardize processes, clarify architectural decisions, and provide clear examples for integrating Microsoft Entra ID authentication.
Key documentation and guidance additions:
Agent and Application Configuration Guidance
Added
.clinerules/AGENTS.mdwith an overview of project information, detailed instructions for selecting and configuring tenant types (Workforce vs. External), a summary comparison table, and references to code style, API usage, and feature flag guidelines.Added
.clinerules/02-Workforce-tenant-configuration.md, a step-by-step guide for creating iOS/macOS sample applications with Microsoft Entra ID using Workforce tenant configuration, including setup, code integration, troubleshooting, and security considerations.MSAL API Usage Documentation
.clinerules/03-MSAL-API-usage.mdproviding practical MSAL authentication code snippets in Swift and Objective-C for both interactive and silent token acquisition, along with best practices and additional resources.Type of change
Risk
Additional information