Create Pull Requests
Create pull requests and keep their changelog current.
Workflow
- Ensure changes are committed in coherent units. Use the
commit-changesskill for staging, splitting, and writing commit messages. - Create a pull request from the current worktree branch.
- Add and commit a changelog entry. Do not create or edit changelog entries
manually here; use the
tenzir-shipskill for generating, formatting, and updating the entry. - If the change affects user-facing behavior documented on docs.tenzir.com,
follow the
update-documentationskill to open a companion docs PR and cross-link the two PRs. - Push the branch.
When doing follow-up edits, ensure that the changelog entries remain in sync
with the changed functionality by routing any entry updates through
tenzir-ship rather than editing changelog files by hand.
PR body
Use this template for the pull request description:
<!-- Intro: what changed and why, in one or two sentences. Focus on user impact. -->
### Review
<!-- What deserves human attention? Architecture impact, trade-offs, risks, open questions. -->
### Details
<details>
<summary>⁉️ Motivation</summary>
<!-- Background, prior state, motivation. Add section only if the intro doesn't make it obvious. -->
</details>
<details>
<summary>🧪 Testing</summary>
<!-- How was this verified? New unit/integration tests, manual steps, CI only? -->
</details>
<details>
<summary>📌 References</summary>
<!-- Issue/ticket link, e.g., TNZ-XXXX. Linked docs PRs. Relevant external resources.-->
</details>
Instructions:
- Replace each HTML comment with a brief explanation.
- Keep the intro to one or two sentences.
- Prefer bullet lists over elaborate prose.
- The diff speaks for itself, don't explain what files you changed.