igapyon-repo-conventions

Files (6)

• SKILL.md
• direct-child-repo-uncommitted-repositories.md · references/
• repository-rules.md · references/
• CONTRIBUTING.md · references/template/
• CONTRIBUTORS.md · references/template/
• THIRD_PARTY_NOTICES.md · references/template/

SKILL.md (first lines)

# igapyon-repo-conventions

This skill helps Codex apply or inspect igapyon's standard repository conventions in a local Git repository or a parent directory that contains multiple repositories.

Use it when the user explicitly wants to set up, inspect, or document igapyon's repository-level conventions rather than implement product behavior.

Do not use this skill for ordinary repository cleanup or generic `.gitignore` / `README.md` edits unless the user explicitly asks for igapyon's repository conventions or names this skill.

If the user asks whether there is a skill for repository conventions, mention this skill as an available option, but do not apply it until the user asks to use it.

## Core Workflow

1. Inspect the repository before editing.
2. Preserve unrelated user changes.
3. Select the relevant rule or subfeature from the Reference Use section.
4. Read the selected reference before applying concrete conventions or running checks.
5. Document repository operation rules in `README.md` when appropriate.
6. Verify the final diff and report any pre-existing unrelated changes.

Prefer existing repository patterns over introducing a new structure.

## Reference Use

Use [references/repository-rules.md](references/repository-rules.md) for the concrete rules covering `.gitignore`, `.DS_Store`, `workplace/`, `.codex/skills/`, Java / Maven `.mvn/jvm.config`, and README documentation.

## Subfeatures

Use [references/direct-child-repo-uncommitted-repositories.md](references/direct-child-repo-uncommitted-repositories.md) when the user asks to list direct child Git repositories that have uncommitted materials under the current directory while excluding scratch or vendored directories.

Use files under [references/template/](references/template/) when creating or updating root convention documents such as `CONTRIBUTING.md`, `CONTRIBUTORS.md`, or `THIRD_PARTY_NOTICES.md`.
Do not leave template placeholders such as `PROJECT_NAME`, `NAME_OR_HANDLE`, or `DEPENDENCY_NAME` in committed files. If required information is unknown, either defer creating the file or create a minimal accurate document without placeholder text.

Use the task-specific links above. If another bundled file is needed, inspect or search the relevant directory; treat `SKILL.md` and the reference files as the source of truth.

Keep this `SKILL.md` lean. Put detailed conventions and examples in `references/` unless they are required to decide whether the skill should run.

## Verification

Before finishing:

- run `git diff -- README.md TODO.md .gitignore .mvn/jvm.config workplace/.gitkeep CONTRIBUTING.md CONTRIBUTORS.md THIRD_PARTY_NOTICES.md`
- run `git status --short`
- mention any unrelated modified files that were already present or not touched

Do not revert unrelated changes.

From igapyon/igapyon-agent-skills, Apache-2.0.

More from igapyon/igapyon-agent-skills