PR requirements

This page describes what is required to land a PR in str0m without it being altered by maintainers.

CI

The CI must pass cleanly. A single GitHub Action runs all checks including:

• Tests
• Clippy
• Rustfmt
• Documentation

Review

• A project member must leave an approving review
• All review comments must be resolved

Changelog

Update CHANGELOG.md with a short entry describing the change:

• Add (breaking) if it introduces breaking changes
• Entries are sorted in reverse order of PR landing (newest at top)

Commit History

• Squash to a single commit including the CHANGELOG.md change
• Rebase off latest main

Commit Message

• Keep the first line short (80-90 characters)
• Omit PR numbers
• Only include a body if it genuinely provides additional information not already in the PR

Issues

If the PR addresses an issue, include Closes #<issue> in the PR description.

Tests

New features must include:

• Unit tests
• Integration tests

---

If a PR does not follow these rules, maintainers may edit/push additional commits or use GitHub's squash button.