Skip to content

docs(project): add README CONTRIBUTING and CODE_OF_CONDUCT #2

Description

@wax911

Background

AniTrend/stackctl is a new public repository and needs the standard project-facing documentation before implementation work scales out.

Use AniTrend/anitrend-v2 as the source reference for conventions:

The content must be contextualised for stackctl; do not blindly copy Android-specific examples, module names, or contribution wording that does not fit a Deno CLI project.

Goals

Add:

  • README.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md

README.md requirements

The README should explain:

  • What stackctl is: a standalone repository-aware Docker Swarm stack controller.
  • Why it exists: extraction of the local-stack deployment workflow from stackctl.sh into a reusable Deno CLI.
  • Primary features:
    • stack generation
    • stack sync/drift checks
    • env rendering
    • Docker Swarm deploy/reload/down/status/logs
    • SOPS/age secrets workflow
    • profile and override support
    • shell completions
    • GitHub Actions setup support
    • Homebrew install path
  • Install status: clearly mark as pre-release until binaries/Homebrew are available.
  • Basic command examples.
  • Link to future docs under docs/.

CONTRIBUTING.md requirements

Base this on the anitrend-v2 CONTRIBUTING structure, but adapt to stackctl:

  • Require contributors to open/discuss an issue before implementation.
  • Require one issue per feature/bug/docs change.
  • Use issue titles with clear scope ownership.
  • Define branch names as <type>/<issue>-<short-description> when an issue exists.
  • Define commit and PR titles as <type>(<scope>): <summary>.
  • Supported types:
    • feat
    • fix
    • chore
    • docs
    • refactor
    • test
    • build
    • ci
    • revert
  • Suggested stackctl scopes:
    • project
    • cli
    • config
    • generate
    • render
    • docker
    • env
    • secrets
    • overrides
    • reload
    • actions
    • release
    • docs
  • Require tests for implementation changes.
  • Require Deno checks before PR:
    • deno task fmt:check
    • deno task lint
    • deno task check
    • deno task test
  • Mention that the project prefers JSR packages and avoids npm unless justified.
  • Mention that generated config templates must preserve comments.
  • Mention that external command execution must stay behind typed process wrappers.

CODE_OF_CONDUCT.md requirements

  • Copy the existing AniTrend Contributor Covenant baseline from anitrend-v2.
  • Keep the enforcement contact as anitrendapp@gmail.com unless the maintainers decide otherwise.
  • Contextualise references to the stackctl project and community.
  • Do not change the intent of the policy.

Acceptance criteria

  • README.md exists and accurately describes stackctl as a Deno CLI project.
  • CONTRIBUTING.md exists and defines stackctl-specific issue, branch, commit, and PR conventions.
  • CODE_OF_CONDUCT.md exists and is based on the AniTrend Contributor Covenant baseline.
  • Documentation does not contain Android/anitrend-v2-specific examples that do not apply to stackctl.
  • README includes a clear pre-release warning until distribution is implemented.

Validation

  • Read the files as a new contributor and verify they answer:
    • What is this project?
    • How do I run checks?
    • How do I name branches/commits/PRs?
    • What behavior is expected from contributors?
    • Where do I report conduct issues?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions