Skip to content

[Chore] Harmonize repository metadata and ct-conventions integration with CTBase #642

Open

Description

@ocots

Goal

Harmonize CTDirect.jl with the conventions of the control-toolbox ecosystem, following the ct-agents harmonization recipes. CTBase.jl is the reference.

Scope — one PR (or settings change) per theme

# Theme Recipe What changes
1 Pin ct-conventions pin-conventions.md the latest ct-conventions release pinned in AGENTS.md and read from a git-ignored clone in .conventions/ (not a git submodule: it breaks Pkg.add on Julia 1.10); AGENTS.md cites rules by identifier; CLAUDE.md redirects to it; CONTRIBUTING.md and _typos.toml updated; every reference to the former Handbook replaced
2 Labels labels.md the reference label set (feature, dev, release, …); package-specific and workflow labels kept; plan validated by the maintainer before it is applied
3 Issue and PR templates, code of conduct issue-templates.md the package's own .github/ISSUE_TEMPLATE/, PR template and CODE_OF_CONDUCT.md removed: the organization's, in control-toolbox/.github, apply instead
4 Typo and lint configuration lint-and-automation.md .JuliaFormatter.toml (BlueStyle); the shared .markdownlint.json (GEN2), without markdownlint-disable comments
5 Obsolete automation lint-and-automation.md obsolete workflows removed (AIHello.yml); any other difference with CTBase's workflows reported, not aligned

Progress is tracked in a comment below, ticked when each PR is merged.

Acceptance criteria

  • AGENTS.md pins a ct-conventions release; no git submodule in the tree; Julia 1.10 installs the package.
  • No reference to the former Handbook outside CHANGELOG.md and BREAKING.md.
  • https://github.com/control-toolbox/CTDirect.jl/issues/new/choose offers the organization's five templates.
  • The labels the templates and the workflows use exist.
  • Package-specific workflows and documentation still work.

Activity

  1. changed the title [-][Chore] Harmonize repository metadata and Handbook integration with CTBase[/-] [+][Chore] Harmonize repository metadata and ct-conventions integration with CTBase[/+] on Oct 16, 2026
  2. ocots commented on Nov 13, 2026

    @ocots
    MemberAuthor

    Theme 2 — labels: plan to validate (nothing applied yet)

    Following recipes/labels.md of ct-agents v0.5.0 (ct-conventions v0.13.0). Reference set: CTBase.jl. Counts are issues + PRs carrying the label, all states.

    Already in place, nothing to do: bug, documentation, duplicate, good first issue, help wanted, question, wontfix, dependencies, release, release: supervised, run breakage, run documentation, run ci github-runner, documentation push preview, ci on main: changes only.

    Action Label Target Issues affected Reason
    rename enhancement feature 13 reference name, used by the organization's templates (theme 3); the issues keep it. Named in .github/ISSUE_TEMPLATE/feature_request.md, which theme 3 removes
    rename internal dev dev (description "Internal change, no user-facing impact") 33 reference name, used by the organization's templates; named in .github/ISSUE_TEMPLATE/developers.md, removed by theme 3
    describe automated pr — 45 description "Opened by a bot", as CTBase
    describe formatting — 45 description "Code formatting only", as CTBase
    describe no changelog — 47 description "Skip the changelog check", as CTBase
    keep run ci occidata-runner — 3 used by CI.yml (target: occidata)
    keep run ci kkt-runner — 0 still a target of CI.yml (github, occidata or kkt)
    keep github_actions — 7 applied by Dependabot (package-ecosystem: github-actions)
    keep roadmap, breaking-change, migration, paper — 1, 1, 1, 2 package-specific
    propose delete invalid — 0 not in the reference set, never used; the maintainer decides
    propose delete help sed — 0 never used; the maintainer decides
    propose merge unit tests into dev dev 1 not in the reference set; the maintainer decides (keeping it is fine too)

    Once validated, theme 3 (removing .github/ISSUE_TEMPLATE/ and CODE_OF_CONDUCT.md in favour of the organization's) can follow: it needs feature and dev to exist.

    Progress of the other themes: theme 1 done on main (ct-conventions v0.13.0, ct-agents v0.5.0); themes 4 and 5 in #678.

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions