Skip to content

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

Closed

Description

@ocots

Agents: read the guide for agents in #310 first (order, difficulty, how to claim an issue, working method). The specification is in this description and in the comments below.

Goal

Harmonize OptimalControlProblems.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 .ct-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/OptimalControlProblems.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.

Notes for this package

Survey of 2026-11-04 against CTFlows.jl, OptimalControl.jl and CTModels.jl:

This is step 0 of #310: agents working on the other sub-issues need AGENTS.md and the pinned conventions.

Activity

  1. added
    devInternal change, no user-facing impact
    on Nov 4, 2026
  2. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Label plan (theme 2): keep these package-specific labels, introduced by #304 (scope modifiers, they trigger nothing on their own): test JuMP backend, test OptimalControl backend, test OptimalControlScalarized backend, test Corleone backend, test comparison. Also keep roadmap and paper (used by #310 and the benchmark-paper themes).

  3. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Label plan (theme 2), addition: keep the labels used by the crons of #305: cron-failure, cron-drafts, cron-capabilities.

  4. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Label plan (theme 2), addition: keep cron-bug and flaky, used by the per-problem bug issues of #305.

  5. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Label plan (theme 2), correction: the scope label for the fourth modeling is test ModelingToolkit backend (not test Corleone backend), see #308.

  6. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Taken by an agent; draft PR to follow.

  7. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Theme 2 — labels plan (requires maintainer validation before applying).
    Surveyed the repository labels and their use in issues/PRs, per the labels recipe. Proposed changes:

    Action Label Target Issues affected Reason
    create — 0 reference set; replaces the package's name
    create — 0 reference set; replaces
    create — 0 reference set; organization template
    create — 0 reference workflow label
    create — 0 reference workflow label
    create — 0 reference workflow label
    rename 39 reference name; preserve issue labels
    rename 9 reference name; preserve issue labels
    keep — 0 reference label; workflow/bot use
    keep — 4 reference label
    keep — 0 reference label/dependabot
    keep — 15 reference label
    keep — 0 reference label
    keep — 0 reference label
    keep — 1 reference label
    keep — 0 reference label
    keep — 0 reference workflow label
    keep — 0 reference label
    keep — 0 reference label
    keep — 6 package-specific benchmark-paper label, required by #310
    keep — 2 package-specific roadmap label, required by #310
    keep — 0 package-specific scope label from #304
    keep — 0 package-specific scope label from #304
    keep — 0 package-specific scope label from #304
    keep — 0 package-specific scope label from #304/#308
    keep — 0 package-specific scope label from #304
    keep — 0 package-specific cron label from #305
    keep — 0 package-specific cron label from #305
    keep — 0 package-specific cron label from #305
    keep — 0 package-specific cron label from #305
    keep — 0 package-specific cron label from #305
    propose delete — 0 obsolete package-specific label; no issues currently carry it
    propose delete — 0 obsolete default label; no issues currently carry it

    The plan deliberately does not apply any setting change yet. Please validate the rows above (or state corrections); after validation I will apply only the approved changes and report the final label set.

  8. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Theme 2 — labels plan (requires maintainer validation before applying).

    Surveyed the repository labels and their use in issues/PRs, per the labels recipe. Proposed changes:

    Action Label Target Issues affected Reason
    create dev — 0 reference set; replaces the package's internal dev name
    create feature — 0 reference set; replaces enhancement
    create release — 0 reference set; organization template
    create run breakage — 0 reference workflow label
    create run ci github-runner — 0 reference workflow label
    create run documentation — 0 reference workflow label
    rename internal dev dev 39 reference name; preserve issue labels
    rename enhancement feature 9 reference name; preserve issue labels
    keep automated pr — 0 reference label; workflow/bot use
    keep bug — 4 reference label
    keep dependencies — 0 reference label/dependabot
    keep documentation — 15 reference label
    keep duplicate — 0 reference label
    keep formatting — 0 reference label
    keep good first issue — 1 reference label
    keep help wanted — 0 reference label
    keep no changelog — 0 reference workflow label
    keep question — 0 reference label
    keep wontfix — 0 reference label
    keep paper — 6 package-specific benchmark-paper label, required by #310
    keep roadmap — 2 package-specific roadmap label, required by #310
    keep test JuMP backend — 0 package-specific scope label from #304
    keep test OptimalControl backend — 0 package-specific scope label from #304
    keep test OptimalControlScalarized backend — 0 package-specific scope label from #304
    keep test ModelingToolkit backend — 0 package-specific scope label from #304/#308
    keep test comparison — 0 package-specific scope label from #304
    keep cron-failure — 0 package-specific cron label from #305
    keep cron-drafts — 0 package-specific cron label from #305
    keep cron-capabilities — 0 package-specific cron label from #305
    keep cron-bug — 0 package-specific cron label from #305
    keep flaky — 0 package-specific cron label from #305
    propose delete help sed — 0 obsolete package-specific label; no issues currently carry it
    propose delete invalid — 0 obsolete default label; no issues currently carry it

    The plan deliberately does not apply any setting change yet. Please validate the rows above (or state corrections); after validation I will apply only the approved changes and report the final label set.

  9. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Correction: the preceding label-plan comment (comment 6629663120) was malformed by shell interpolation of Markdown backticks. Comment 6629666925 is the authoritative, correctly rendered plan; no label settings have been changed.

  10. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Theme 2 — labels applied.

    The validated plan was applied:

    • internal dev → dev (39 existing issues preserved)
    • enhancement → feature (9 existing issues preserved)
    • Created missing reference labels: release, run breakage, run ci github-runner, and run documentation, with CTBase metadata.
    • Created the package-specific scope and cron labels listed in the plan.
    • Deleted help sed and invalid; neither was attached to an issue.
    • Kept paper, roadmap, and the existing package/workflow labels.

    The final repository label set was checked against the approved plan and the CTBase reference set. No unapproved label was changed.

  11. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    The approved label plan is applied (comment 6629736595). The work is now split according to the recipe: theme 1 in draft PR #315, themes 4–5 in draft PR #316, and theme 3 in draft PR #317. Theme 3 can be merged after review; its post-merge organization-template check remains to be recorded.

  12. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Harmonization complete.

    All five themes are done:

    The three pull requests are merged. The repository community profile now points to the organization-wide PR template and code of conduct. This tracking issue can be closed by the maintainer.

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

Metadata

Metadata

Assignees

Labels

devInternal change, no user-facing impact

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions