status-im/status-go
2
0
Fork 0
mirror of https://github.com/status-im/status-go.git synced 2025-02-24 12:48:46 +00:00
Code Issues Projects Releases Wiki Activity
status-go/_docs/policies/submitting-policy.md
Samuel Hawksby-Robinson 31baf2b892 docs(policy)_: Changes to closely follow the ADR standard
2025-01-22 15:12:34 +00:00

2.6 KiB
Raw Blame History

Purpose

Policy Zero establishes the foundational guidelines for creating, reviewing, and maintaining policies in the status-go Git repository. This policy aims to create a collaborative, inclusive, and transparent process for defining repository policies, specifically regarding how developers engage with and contribute to the status-go repository.

Submitting a Policy Proposal

  • Any individual MAY propose a new policy.
  • Policy ideas SHOULD be discussed with contributors who wish to have a voice in how the repository operates, including Core Contributors (CCs) and external contributors.
  • All policies MUST be submitted to the _docs/policies directory as a pull request (PR) within the status-go repository.
  • All policies MUST be in Markdown format.
  • Policy file names MUST follow File name conventions for ADRs, e.g. submitting-policy.md.

Review and Approval Process

The core function of the review and approval process for policy PRs is to reach consensus on any issue and to reflect the range of perspectives among all contributors who wish to have a voice in how the status-go repository operates, including both Core Contributors (CCs) and external contributors. Policy submissions must aim to achieve broad contributor support and give key stakeholders a chance to gain context of the policy requirements.

  • Policy PRs SHOULD be reviewed by as many contributors as possible who wish to engage in the process.
  • Any CC MAY review, approve, and/or request changes to a policy proposal PR.
  • For any policy PR to be eligible for merging, it:
    • MUST address all feedback provided during the review process.
    • MUST be approved by all team leads (of Status Desktop and Mobile).
    • MUST be approved by all members of the @status-im/status-go-guild GitHub team.
    • MUST receive a minimum of six approvals from CCs.

Policy Amendments and Archival

Policies can be amended or archived to ensure they remain relevant and aligned with contributor needs.

  • Amendments
    • Policies MAY be amended at any time.
    • Amendments MUST be submitted via a PR to the status-go repository.
  • Archival
    • Policies MAY be archived if they are obsolete or replaced by newer policies.
    • Archival MUST be performed by submitting a PR that moves the policy to _docs/policies/archived.
  • The PR MUST include a rationale for the proposed amendment or archival in the PR description.
  • The PR MUST follow the Review and Approval Process.