Skip to content

docs: formalize strict issue-first fork-and-PR contribution workflow in CONTRIBUTING.md #1

Closed

Description

@Icedmist

Summary

Update CONTRIBUTING.md to establish and formalize the mandatory 5-step contribution protocol for all contributors and automated agents.

Context & Workflow Rules

To maintain clean code governance and traceability across the project:

  1. GitHub Issue First: All work must start with an issue opened in the upstream repository (geekinks/problemspot). Direct changes without an issue are not accepted.
  2. Fork & Dedicated Branch: Contributors must fork geekinks/problemspot to their personal GitHub account, sync with upstream/main, and create a dedicated feature branch (<type>/<kebab-case-description>). Commits directly to main are prohibited.
  3. Implement, Verify & Commit: Adhere to code standards, TypeScript strict typing, brand guidelines (brand.md), and run test suites and linters locally. Commit using Conventional Commits.
  4. Push & Open PR: Push the branch to the personal fork (origin) and open a PR targeting geekinks/problemspot:main referencing the issue (Closes #...).
  5. Review & Squash Merge: Maintainers review the PR. Once approved and CI checks pass, maintainers squash-merge into main and delete the branch. Contributors sync their local main back from upstream/main.

Acceptance Criteria

  • Update CONTRIBUTING.md with the explicit 5-step contribution lifecycle.
  • Add explicit instructions that all issues must be opened in the main repo (geekinks/problemspot).
  • Detail branch naming conventions (feat/*, fix/*, docs/*, etc.) and Conventional Commit requirements.

Activity

  1. added 2 commits that reference this issue on Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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