ci: update rules, details and documentation about GenAI use and OpenAI Codex product

And use last develop version of Swift Package

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

Author: pylapp

.github/CODEOWNERS

@@ -41,5 +41,6 @@ NOTICE.txt @pylapp @ludovic35
 
 README.md @ludovic35 @pylapp
 
+AGENTS.md @pylapp
 THIRD_PARTY.md @pylapp
 renovate.json @pylapp

.github/CONTRIBUTING.md

@@ -243,14 +243,14 @@ Signed-off-by: Tayeb Sedraia <[email protected]>
 Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
 ```
 
-Finaly, if you want to note somewhere you used *generative AI* tool, you can add the field "Assisted-by" in your commit with the model in use and in parenthsies some commercial name.
+Finaly, if you want to note somewhere you used *generative AI* tool, you can add the field "Assisted-by" in your commit with the model in use and in parenthesis some commercial name.
 
 ```text
 feat: add thousands of tokens (Orange-OpenSource/ouds-ios#123)
 
 Add thousands of tokens and hundreds of tests.
 
-Assisted-by: GPT-4o-mini (Dinootoo)
+Assisted-by: GPT-4o-mini (Orange Dinootoo)
 ```
 
 ## Developer Certificate of Origin

.github/DEVELOP.md

@@ -33,6 +33,9 @@
 - [Update of dependencies](#update-of-dependencies)
 - [Update 3rd parties](#update-3rd-parties)
 - [CI/CD](#cicd)
+- [Use of GenAI](#use-of-genai)
+  * [Note in commits](#note-in-commits)
+  * [OpenAI Codex](#openai-codex)
 
 ## Technical preconditions
 
@@ -734,3 +737,34 @@ However of course you will have to define all the variables, secrets and have th
 You can find more details about the pipelines, how to set up runners and scripts to use [in the wiki](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/wiki/51-%E2%80%90-About-continuous-integration-and-delivery).
 
 In few words, there is a pipeline containing some stages and HIRDjobs to build alpha, nightly/beta and production releases.
+
+## Use of GenAI
+
+### Note in commits
+
+The use of generative artifical intelligence (in short "GenAI") is not forbidden.
+However, to keep records of this new usage, contributors and maintainers must add inside the commit body if they use GenAI, which model and how.
+Indeed GenAI can be used to generate source code and also review pull requests.
+In all cases, the field *Assisted-by* must be added with the Large Language Model ("LLM") name and product.
+
+For example, if the Orange tool named _Dinootoo_ has been used with GPT-4o-mini as LLM to generate some code:
+
+```text
+Assisted-by: GPT-4o-mini (Orange Dinootoo)
+```
+
+Or if the Codex product has been used to make some pull request reviews or to work on issues, using the GitHub Connector (see [here for LLM for Codex cloud details](https://openai.com/fr-FR/index/introducing-codex/)):
+
+```text
+Assisted-by: codex-1 (OpenAI Codex)
+```
+
+The main things to note are the LLM in use and the products bebind with, if relevant, company name to have no doubt.
+
+### OpenAI Codex
+
+You may notice [Codex (OpenAI product)](https://chatgpt.com/codex) is used. Indeed this product can be integrated to GitHub repositories thanks to environments and [ChatGPT Plus, Pro, Business, Edu, and Enterprise plans](https://developers.openai.com/codex/quickstart). We do not use [codex GitHub Action](https://github.com/openai/codex-action) nor the [lightweight terminal agent](https://github.com/openai/codex) but the [GitHub ChatGPT Codex Connector](https://developers.openai.com/codex/cloud).
+
+For any commits or content provided by Codex, apply the same rules as explained previously.
+
+Keep in mind the repositories of OUDS iOS (Swift Package and design system toolbox) are two different enviroments. Thus you must not ask Codex to work on an issue for the design toolbox, as the issues are all gathered in the Swift Package repository (to help manaement of projects and milestones); Codex will try to work for the app on the package which is not acceptable and won't work. However Codex can be used for pull requests reviews and to work on issues (for Swift Package repo only so). To use Codex, mention `@codex` and it will react.

AGENTS.md

@@ -1,4 +1,13 @@
-# Agents.md
+---
+type: ai-agent-guide
+framework: OUDS-iOS-Design-System-Toolbox
+language: Swift
+ui-framework: SwiftUI
+platforms: [iOS, iPadOS, macOS, visionOS, watchOS, tvOS]
+min-deployment: iOS 15.0
+---
+
+# OUDS iOS Design System Toolbox app - AI Agent Guide
 
 This file provides guidance to AI coding agents when working with code in this repository or with OUDS iOS products.
 
@@ -20,6 +29,7 @@ The products are written in Swift with SwiftUI as UI framework and Swift 6 (form
 - *theme*: a set of tokens, assets like fonts and images, to use in app to style it and change their look and feels
 - *tuning*: some small configuration elements for a theme like rounded corners
 - *token provider*: an object in a theme gathering tokens (semantics and components)
+- *component*: mainly a SwiftUI view with specific features and layouts like buttons, switch, link etc.
 
 ## Code formating
 
@@ -229,82 +239,13 @@ To update the build number of the app:
 bundle exec fastlane update_build_number
 ```
 
-## Code samples
-
-### Import OUDS product
-
-Import OUDS umbrella product gathering all other librairies:
-```swift
-import OUDSSwiftUI
-```
-
-### Instanciate a theme object
-
-Create a theme for Orange product:
-```swift
-    let theme = OrangeTheme()
-```
-
-### Inject a theme in an app
-
-Use an `OUDSThemeableView` to inject the theme:
-
-```swift
-OUDSThemeableView(theme: theme) {
-
-}
-```
-
-### Get the theme object
-
-Get the theme object as environement object:
-```swift
-@Environment(\.theme) private var theme
-```
-
-### Use tokens from theme
-
-Use colors (semantic tokens) defined in a theme:
-```swift
-theme.colors
-```
-
-Use borders (semantic tokens) defined in a theme:
-```swift
-theme.borders
-```
-
-Use fonts (semantic tokens) defined in a theme:
-```swift
-theme.fonts
-```
-
-Use sizes (semantic tokens) defined in a theme:
-```swift
-theme.sizes
-```
-
-Use spaces (semantic tokens) defined in a theme:
-```swift
-theme.spaces
-```
-
-Use dimensions (semantic tokens) defined in a theme:
-```swift
-theme.dimensions
-```
-
-Use elevations (semantic tokens) defined in a theme:
-```swift
-theme.elevations
-```
-
-Use grids (semantic tokens) defined in a theme:
-```swift
-theme.grids
-```
+## Review guidelines
 
-Use opacities (semantic tokens) defined in a theme:
-```swift
-theme.opacities
-```
+- Check if sources are formatted
+- Run linter, no error must appear
+- Run tests, they must all pass
+- Check if there is dead coden and leave a comment saying the elements which seem toi be dead / not used
+- Build documentation, no error must appear
+- Check leaks, no leak must appear
+- Check if functions are too long or too complicated,  must be low
+- Check if the commit has been designed-off (i.e. DCO appplied) by all commits authors