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 process.

[coderabbitai]

Walkthrough

Updates to CONTRIBUTING.md with formatting corrections, restructured release workflow steps, reordered tagging and publishing sequence, addition of workflow approval step for pub.dev publication, and changelog update requirement. Guidance added for replacing HEAD with version tags in autogenerated URLs.

Changes

Cohort / File(s)	Summary
Contributing Documentation CONTRIBUTING.md	Corrected bullet formatting (step 4), restructured release steps (10–13), reordered tag creation and release steps, added workflow approval step for pub.dev publication (step 13), added changelog update via headwayapp (step 14), and added guidance for replacing HEAD with version tags in URLs

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify the new release workflow steps are clear and actionable
• Confirm the reordered sequence (tag creation before release) is correct
• Check that the approval workflow reference is accurate for the team's process

Poem

🐰 Hop through the steps with care,
Documentation now refined with flair,
Release workflows rearranged just right,
Approval gates and changelogs bright!
Contributing paths now crystal clear—
Happy hopping for all the year! 🌟

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 title accurately reflects the main change: clarifying release steps in CONTRIBUTING.md documentation.
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

---

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.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix malformed markdown link syntax.

Line 203 (step 12) contains double opening parentheses in the link: ]((https://...)). This should be ](https://...).

-12. Create a release on GitHub following the [previous releases]((https://github.com/ably/ably-flutter/releases)) as examples.
+12. Create a release on GitHub following the [previous releases](https://github.com/ably/ably-flutter/releases) as examples.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	12. Create a release on GitHub following the [previous releases]((https://github.com/ably/ably-flutter/releases)) as examples.
	12. Create a release on GitHub following the [previous releases](https://github.com/ably/ably-flutter/releases) as examples.

🤖 Prompt for AI Agents

In CONTRIBUTING.md around line 203, the markdown link in step 12 uses malformed
syntax with double opening parentheses `]((https://...) )`; replace it with the
correct link syntax `](https://...)` so the link renders properly (remove the
extra parenthesis).

[maratal]

@ttypic

[coderabbitai]

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!