Skip to content

[Advancement] Add branch protection documentation and contributor preflight script #807

Description

@Nanle-code

Objective

Document required branch protections and ship a preflight script that mirrors merge gates locally.

Target area

scripts/, CONTRIBUTING

Context

Contributors should know that PRs merge only with passing CI and no conflicts.

Requirements

  • Document required status checks and conflict-free requirement
  • Provide scripts/preflight-pr.sh running fmt/clippy/tests subset
  • Link from CONTRIBUTING PR guidelines

Acceptance criteria

  • Docs explicitly require all CI pass + no conflicts before merge
  • Preflight script exists and is referenced
  • Script exits non-zero on failures

Pull request merge requirements

Pull requests that resolve this issue must not be merged until all of the following are true:

  1. All required CI checks are green on the latest commit of the PR (build, tests, lint/format, and any workflow jobs required by branch protection).
  2. The branch has no merge conflicts with the target branch (master / default), and a clean merge or rebase is possible without unresolved conflicts.
  3. Review feedback is addressed, and the change remains focused on this issue’s acceptance criteria.

Contributors should run the local CI-equivalent checks before opening or updating the PR (see CI_ENFORCEMENT.md and CONTRIBUTING.md).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programci-cddocumentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions