Skip to content

task: repository-setup - Establish repository configuration and contribution structure #13

Open

Description

@ashleyshaw

Task Summary

Establish and document the repository’s GitHub configuration structure for its React/Vite/TypeScript application.

Recommended structure for the repository:

.github/
├── dependabot.yml
├── README.md
├── CODEOWNERS                 # after maintainers confirm owners
└── workflows/
    ├── dependency-automation.yml   # existing, centrally managed
    └── dependency-validation.yml   # existing, centrally managed

.mergify.yml                   # repository root

Check organisation-provided community-health defaults before adding local ISSUE_TEMPLATE/, pull request templates, CONTRIBUTING.md or SECURITY.md. Add local overrides only where repository-specific requirements justify them.

Linked Stories/Tasks

Reference #10 for Dependabot schedules, grouping, limits and major-version ignores. Reference #11 for Mergify eligibility, required checks, build verification and merge-controller compatibility. Keep implementation ownership in those existing issues rather than duplicating it.

Milestones & Timeline

No milestone or deadline specified.

Acceptance Criteria

  • Task is clearly defined and actionable
  • Task is relevant to project goals
  • Documentation updated if needed
  • Changelog entry prepared for PR if task completed via PR
  • Correct branch prefix for PR (task/)
  • PR description updated with relevant details
  • Changelog entry prepared for PR (if applicable)
  • Labels/types match org standards
  • .github/README.md documents configuration locations, ownership and linked automation issues
  • Existing centrally managed workflows remain unchanged
  • Local community-health files do not unnecessarily duplicate organisation defaults
  • Mergify placement and build-verification dependencies are documented correctly
  • Organisation-default visibility, branch and source paths are verified
  • Local override locations are audited without unapproved deletions
  • Inherited issue templates, pull request template, contribution guide and security policy are verified through GitHub
  • .github/README.md explains inheritance, overrides and repository-specific configuration

Steps / Checklist

  • Review applicable organisation defaults and repository requirements
  • Document the recommended structure and automation responsibilities
  • Confirm maintainers before introducing CODEOWNERS
  • Identify justified local template overrides for human review

Enable and verify organisation defaults

GitHub supplies organisation defaults automatically; there is no inheritance setting to enable, and files are not copied into the target repository. Follow GitHub’s inheritance rules.

  1. Verify the source
    • Confirm lightspeedwp/.github is public and identify its default branch.
    • Verify the shared .github/ISSUE_TEMPLATE/, pull request templates, CONTRIBUTING.md and SECURITY.md exist on that branch.
    • Follow that repository’s AGENTS.md. Changes to shared issue or pull request templates require human review and are outside this issue’s implementation scope.
  2. Check for local overrides
    • Inspect the target repository’s default branch, including its root, .github/ and docs/.
    • Do not create local community-health files merely to enable inheritance.
    • Any file in local .github/ISSUE_TEMPLATE/, including only config.yml, disables all inherited issue templates.
    • A local contribution guide, security policy or pull request template overrides its corresponding organisation default.
    • Report existing overrides for review; do not delete them automatically.
  3. Verify the contributor experience
    • Open GitHub’s new-issue page and confirm the shared template chooser appears.
    • Open a test pull request and verify the applicable default template populates its description.
    • Check the repository’s contribution and security-policy links resolve to the organisation defaults.
    • Record the source paths, verification results and any intentional exceptions in .github/README.md.
  4. Keep repository-specific configuration separate
    • CODEOWNERS, workflows, Dependabot configuration and Mergify configuration are not inherited through this mechanism.
    • Keep Dependabot implementation in the existing linked issue and Mergify at the repository root.
    • Do not modify centrally managed dependency workflows locally.

Evidence and remaining gaps: The inspected organisation repository contains the shared template folders and root contribution/security documents. The target’s main branch has only workflows/ inside .github/; source visibility, default branches and possible overrides under docs/ still require verification.

Dependencies

Dependabot and Mergify implementation remain covered by the linked issues. Mergify requires confirmed check-run names, build verification and safeguards against competing merge automation.

Additional Context

README.md and package.json establish the application stack; no root AGENTS.md was found. The live Task template matches its GitHub-backed description, but label ordering differs; this issue preserves Linear’s order. Its legacy status:needs-triage label is retained despite the explicitly requested Todo status.


Definition of Ready (DoR)

  • Task described and scoped
  • Estimate added if relevant

Definition of Done (DoD)

  • Task completed and documented
  • Changelog entry prepared for PR
  • PR uses correct branch prefix (task/)
  • Documentation/changelog updated if needed
  • Branch deleted after merge
  • Linked issue(s) updated with latest status and closed after merge,
  • The related epic should not be closed, instead updated with a comment to reflect the closed issue

Unanswered clarification questions

These questions identify outstanding verification and description reconciliation; they do not authorise repository changes.

  1. Which organisation-default source paths and default branches have been verified, and where should their revision-specific evidence be recorded?
  2. Which local community-health overrides exist, including under docs/, and which are intentionally required?
  3. What contributor-facing evidence confirms that issue templates, pull request templates, contribution guidance and security-policy links resolve as intended?
  4. Which maintainers should confirm CODEOWNERS ownership, and what repository-specific setup remains outside the existing Dependabot and Mergify issues?
  5. Which statements about Mergify placement, root AGENTS.md availability and the previously requested status are historical or superseded, and what evidence should support their reconciliation?

Activity

  1. linear-code commented on Oct 3, 2026

    @linear-code
  2. self-assigned this
    on Oct 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Fields

Priority

None yet

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions