This file describes the AI guidelines for operations in this directory.

## Directory structure

- <project>/: A single project repository
    - INFO.md: Project information, including where the code is hosted
    - AI.md: AI guidelines for the project
    - workitems/: A directory containing workitem prompts
        - <date>-<workitem-name>.md: A prompt file for a project workitem

### File format

File format is markdown.
It contains checkboxes, that must only be checked if the information is available and provided.

#### Project info file format

A project info file follows the following format:

```markdown
## <Project name>

- [ ] Repo host: <repo host url, eg https://gitea.fteamdev.valuya.be/ or https://github.com/organizations/Ebitda-SRL>
- [ ] Repo url: <url of the project repository>
- [ ] Target branch: <target branch for the PR>
- [ ] AI guidelines: <path to ai guidelines md file in the project repo>
- [ ] Remote data: <url to remote data to include in prompt>
- [ ] Jira component: <component of the jira>

```

#### Work item prompt file format

A work item prompt file follows the following format:

```markdown
## <workitem name>

<short paragraphs describing the workitem, with line wrapping>

- [ ] Jira: <reference of the jira ticket with a link>
- [ ] Implementation: <reference of the implementation within the project repo, optionally with a link>
- [ ] Active

### Log

<log to be filled as the workitem is processed, implementation logs will be automatically added to this section>

```

The active checkbox is optional and should be checked if the workitem is active. Inactive workitems should be ignored.
In the absence of the active checkbox, the workitem is assumed to be active.

### Credentials

This section describes credentials to use when interacting with various apis and services.

The actual credentials are provided in the environment variables.

#### Jira

#### Github

- [ ] host: https://github.com/organizations/Ebitda-SRL

#### Gitea

- [x] host: https://gitea.fteamdev.valuya.be
    - credential type: username/password
    - username variable: GITEA_USERNAME
    - password variable: GITEA_PASSWORD