Skip to content

docs: add kun-init 4-file documentation structure#63

Open
Soarecos wants to merge 1 commit into
mainfrom
KUNAI-8
Open

docs: add kun-init 4-file documentation structure#63
Soarecos wants to merge 1 commit into
mainfrom
KUNAI-8

Conversation

@Soarecos

@Soarecos Soarecos commented Jul 2, 2026

Copy link
Copy Markdown

Description

The objective of this PR is to introduce the standard kun-init 4-file documentation structure with strict ownership and no duplication across files:

  • README.md — what the library is, installation, usage. Dev workflow removed and pointed at CONTRIBUTING.md.
  • AGENTS.md — short agent-facing overview: what it is, domain, code layout, quality gates (real Composer scripts) and hard constraints.
  • CONTRIBUTING.md — reconciled the existing file; now owns all development workflow (setup, quality gates) alongside the existing PR guidelines.
  • CLAUDE.md — contains @AGENTS.md.

Issues

  • KUNAI-8

Details

  • Layout detected: library (type: library, PSR-4 Kununu\DataFixtures\, consumed as a Composer package). No k8s-env link added (not a deployed service).
  • README ## Tests section moved into CONTRIBUTING.md to remove duplication; CI/SonarCloud badges kept.
  • Quality gates reference the real Composer scripts; PHP version referenced via composer.json (require.php) rather than hardcoded.
  • CLAUDE.md added normally (not listed in .gitignore).

@Soarecos Soarecos requested a review from a team as a code owner July 2, 2026 17:25
@sonarqubecloud

sonarqubecloud Bot commented Jul 2, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant