added codex structure
This commit is contained in:
107
.codex/project.md
Normal file
107
.codex/project.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# Project configuration for Codex
|
||||
|
||||
Edit this file for each repository.
|
||||
|
||||
## Project identity
|
||||
|
||||
Project name: `CHANGE_ME`
|
||||
Project description: `CHANGE_ME`
|
||||
Primary language/runtime: `CHANGE_ME`
|
||||
|
||||
## Project mode
|
||||
|
||||
Choose one:
|
||||
|
||||
```text
|
||||
project_mode: personal
|
||||
project_mode: work
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- `personal`: Docker base image policy is neutral.
|
||||
- `work`: prefer Red Hat UBI minimal images when possible.
|
||||
|
||||
## Enabled profiles
|
||||
|
||||
Enable only the profiles that apply to this repository:
|
||||
|
||||
```text
|
||||
enabled_profiles:
|
||||
- docker
|
||||
- ansible
|
||||
- python
|
||||
```
|
||||
|
||||
## Branching model
|
||||
|
||||
Codex MUST:
|
||||
|
||||
- start from `develop`;
|
||||
- create one branch per task;
|
||||
- use one of these prefixes:
|
||||
- `feature/`
|
||||
- `fix/`
|
||||
- `hotfix/`
|
||||
- `chore/`
|
||||
- `docs/`
|
||||
- `refactor/`
|
||||
|
||||
Examples:
|
||||
|
||||
```text
|
||||
feature/add-healthcheck
|
||||
fix/selinux-authorized-keys
|
||||
hotfix/restore-container-startup
|
||||
```
|
||||
|
||||
## Commit style
|
||||
|
||||
Codex MUST use Conventional Commits.
|
||||
|
||||
Examples:
|
||||
|
||||
```text
|
||||
feat: add Docker healthcheck
|
||||
fix: correct Ansible SELinux handling
|
||||
docs: add ADR for deployment strategy
|
||||
test: add regression tests for parser
|
||||
refactor: simplify container startup logic
|
||||
chore: update Codex project metadata
|
||||
```
|
||||
|
||||
## Test command
|
||||
|
||||
All tests MUST be executed inside Docker containers.
|
||||
|
||||
Configure the canonical test command for this repository:
|
||||
|
||||
```bash
|
||||
CHANGE_ME
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
docker compose run --rm app pytest
|
||||
```
|
||||
|
||||
```bash
|
||||
docker compose run --rm app ruff check .
|
||||
docker compose run --rm app pytest
|
||||
```
|
||||
|
||||
```bash
|
||||
docker compose run --rm ansible ansible-playbook --syntax-check playbook.yml
|
||||
```
|
||||
|
||||
If no test command is configured, Codex MUST:
|
||||
|
||||
1. report that tests are not configured;
|
||||
2. suggest the appropriate Docker-based test command;
|
||||
3. avoid claiming that the task is fully verified.
|
||||
|
||||
## Documentation language
|
||||
|
||||
Documentation language: English.
|
||||
Code comments language: English.
|
||||
Reference in New Issue
Block a user