Skip to content

Describe the shared configuration in the README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
woksin merged 1 commit into from
Aug 28, 2026
Merged

Describe the shared configuration in the README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# Common
Common configuration for all repositories

Shared configuration for all repositories in the [Cratis](https://github.com/Cratis) organization.

This repository holds the baseline every Cratis repository starts from, so conventions are defined once and stay consistent across the organization.

## What is shared here

- **AI-assistant configuration** — [`.ai/`](.ai/README.md) is the single source of truth for rules, agents, prompts, skills, and hooks used by AI coding assistants. `.claude/`, `.agents/`, `AGENTS.md`, and the `.github/` instruction/prompt/skill files are generated adapters that surface the same content to each tool.
- **GitHub templates** — issue templates and the pull request template under [`.github/`](.github).
- **CodeQL configuration** — the shared [CodeQL config](.github/codeql/codeql-config.yml) used for code scanning.
- **Standard workflow wrappers** — thin caller workflows (package updates, PR artifact cleanup, Copilot instruction sync and propagation, deployment approval) that delegate to the reusable workflows in [Cratis/Workflows](https://github.com/Cratis/Workflows).

## Who consumes it

Every repository in the Cratis organization. Changes to the shared instruction files on `main` are propagated to the other Cratis repositories by the [propagate workflow](.github/workflows/propagate-copilot-instructions.yml), and instruction changes made elsewhere can be synced back in through the [sync workflow](.github/workflows/sync-copilot-instructions.yml). The workflow wrappers themselves are bootstrapped into repositories from [Cratis/Workflows](https://github.com/Cratis/Workflows).

Part of [Cratis](https://www.cratis.io) — free, MIT-licensed tools for building event-sourced and CQRS applications.

## License

[MIT](LICENSE)
Loading