docs: clarify release steps in CONTRIBUTING.md

[ttypic]

Clarify release steps in CONTRIBUTING.md

Summary by CodeRabbit

• Documentation
  • Updated contribution guidelines with refinements to the release workflow: normalized step numbering, reordered publishing steps, and added two new steps for requesting approval to publish and updating the public changelog.
  • Expanded changelog guidance to instruct replacing autogenerated HEAD links with the target version tag and preserved existing examples and manual workflow notes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Updated CONTRIBUTING.md: fixed release step numbering and formatting, reordered release steps (tagging/pushing before publish), added approval step for pub.dev publication, added changelog update via Headway, and added guidance to replace HEAD with the target version tag in autogenerated changelog URLs.

Changes

Cohort / File(s)	Summary
Contributing Documentation CONTRIBUTING.md	Fixed bullet formatting (step 4), restructured and renumbered release steps (10–14), reordered tag creation/push before publish, added workflow approval step for publishing to pub.dev (new step 13), added changelog update via Headway (new step 14), and added instruction to replace HEAD with the target version tag in autogenerated changelog URLs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify the new release step ordering and numbering are consistent and correct.
• Confirm wording and references to the approval workflow and Headway changelog update are accurate.
• Check the example instruction for replacing HEAD with a version tag is clear and technically correct.

Poem

🐰 I nibbled through steps, tidy and neat,

Tags now in order, no skip of a beat,
Approvals requested, changelogs in sight,
A hop and a push — the release feels right,
Happy trails for the code, moonlit and bright 🌙

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately summarizes the main change: clarifying release steps in the CONTRIBUTING.md file, which aligns with the modifications that reorganize, add, and extend guidance for the release process.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-release-process

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e2c6920 and 3006413.

📒 Files selected for processing (1)

• CONTRIBUTING.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[uncategorized] ~191-~191: The official name of this software platform is spelled with a capital “H”.
Context: ...ntegration/ios - Commit this 4. Run [github_changelog_generator`](https://github.co...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: android
• GitHub Check: ios
• GitHub Check: ios
• GitHub Check: android (24)
• GitHub Check: android (29)

🔇 Additional comments (2)

CONTRIBUTING.md (2)

191-195: Well-structured changelog guidance with helpful clarification.

The expansion at line 195 adding explicit instruction to "replace HEAD in the autogenerated URL's with the version tag (e.g. v1.2.3)" is a valuable clarification that reduces ambiguity for release maintainers.

---

201-205: Logical reordering and clear new approval workflow steps.

The reordering of tagging (step 10) and pushing (step 11) before the GitHub release creation (step 12) is sensible. The addition of steps 13–14 provides explicit guidance on the approval workflow (Release Workflow approval) and changelog update process (Headway integration), which removes ambiguity from the process.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

201-205: Clarify that pub.dev publishing is now automated via Release Workflow.

The restructured release process (steps 10–14) removes the manual flutter pub publish step and introduces automated publishing through the Release Workflow (step 13). While this is a good practice, the documentation should explicitly state that pub.dev publication is now delegated to the CI/CD workflow rather than run manually. This will help maintainers understand the flow and avoid duplicate publication attempts.

Consider adding a clarifying note before step 10, such as:

+After the release PR is landed:
+
 10. Create a tag named like `v1.2.3`, using `git tag v1.2.3`

This makes it clear that the next phase shifts from PR approval to automated release tasks.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between aca05b9 and e2c6920.

📒 Files selected for processing (1)

• CONTRIBUTING.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[uncategorized] ~191-~191: The official name of this software platform is spelled with a capital “H”.
Context: ...ntegration/ios - Commit this 4. Run [github_changelog_generator`](https://github.co...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: android
• GitHub Check: ios
• GitHub Check: android (24)
• GitHub Check: ios
• GitHub Check: android (29)

🔇 Additional comments (1)

CONTRIBUTING.md (1)

191-195: Approve added guidance for URL replacement.

The new instruction at line 195 to replace HEAD in autogenerated URLs with the actual version tag (e.g., v1.2.3) is helpful and removes ambiguity. This clarification improves the release process documentation.