Skip to content

docs: centralize shared community files #5

Description

@Jammy2211

Overview

Make PyAutoScientist the canonical home for PyAutoLabs-wide community policy,
replacing drift-prone copies with short links. Use the existing public
PyAutoLabs/.github repository as GitHub's organization-wide distribution layer,
and remove local templates that unnecessarily override its shared forms.

Plan

  • Add canonical Code of Conduct and contribution guidance to PyAutoScientist.
  • Replace existing repository copies with uniform pointers.
  • Use PyAutoLabs/.github to cover repositories without local overrides.
  • Preserve distinct library, workspace, and organism contribution workflows.
  • Remove duplicated local issue templates so organization defaults apply.
  • Validate links and record adjacent policies suitable for later centralization.
Detailed implementation plan

Work Classification

Workspace documentation

Affected Repositories

  • PyAutoScientist (primary)
  • .github
  • HowToFit
  • HowToGalaxy
  • HowToLens
  • PyAutoArray
  • PyAutoBrain
  • PyAutoCTI
  • PyAutoFit
  • PyAutoGalaxy
  • PyAutoHands
  • PyAutoHeart
  • PyAutoLens
  • PyAutoMemory
  • PyAutoMind
  • PyAutoNerves
  • autocti_workspace
  • autofit_workspace
  • autofit_workspace_test
  • autogalaxy_workspace
  • autolens_workspace
  • autolens_workspace_test

Branch Survey

Most repositories are clean on main.

Known coordination state:

  • PyAutoBrain is claimed by hygiene-adjacent-docstrings.
  • PyAutoHands is claimed by notebook-adjacent-docstrings.
  • PyAutoCTI and PyAutoFit are claimed by testmode-env-drift.
  • PyAutoMemory has an unrelated reading-queue.md modification.
  • autolens_workspace has unrelated start_here.py and notebook changes.
  • PyAutoMind is on feature/mind-lifecycle-auto-index; the new task prompt is
    currently untracked there.

Suggested branch: feature/central-community-docs

Worktree root: ~/Code/PyAutoLabs-wt/central-community-docs/ (created once
the existing claims clear)

Implementation Steps

  1. Add PyAutoScientist/CODE_OF_CONDUCT.md, using the existing organization
    Contributor Covenant 2.1 policy as the base, with PyAutoLabs-wide scope and
    an explicit private reporting route.
  2. Add PyAutoScientist/CONTRIBUTING.md, reconciling external contribution
    guidance with the distinct library, workspace, and living-organism
    development models. Replace stale PyAutoPrompt references with PyAutoMind.
  3. Replace .github/CODE_OF_CONDUCT.md and .github/CONTRIBUTING.md with
    concise links to the PyAutoScientist canonical documents.
  4. Replace the existing full local copies across the affected repositories with
    uniform pointer files. Repositories without local overrides will inherit the
    organization defaults automatically.
  5. Remove identical legacy bug and feature templates from PyAutoArray,
    PyAutoFit, PyAutoGalaxy, PyAutoLens, PyAutoNerves, autofit_workspace,
    autogalaxy_workspace, and autolens_workspace so the organization YAML forms
    take effect.
  6. Verify the inventory, links, absence of stale workflow references, and
    absence of remaining full policy duplicates.
  7. Keep licenses and scientific citation guidance local. Leave the AI statement
    content for its own task; record SECURITY.md, SUPPORT.md, and GOVERNANCE.md
    as future candidates for the same architecture.

Key Files

  • PyAutoScientist/CODE_OF_CONDUCT.md
  • PyAutoScientist/CONTRIBUTING.md
  • .github/CODE_OF_CONDUCT.md
  • .github/CONTRIBUTING.md
  • Existing repository-root policy files in the affected repositories
  • Existing duplicated .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md
    files in the eight overriding repositories

Original Prompt

Click to expand starting prompt

The repos all share and duplicate CODE_OF_CONDUCT.md, CONTRIBUTING.md, can we
move their up to PyAutoScientist and have each repo level on just direct to that?
We will add an AI STATEMENT next which follows the same logic. Check if anything
else falls in this remit

Metadata

Metadata

Assignees

No one assigned

    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