Repository navigation
Conversation
Explain commit types, scopes and breaking change syntax with examples, document the Git hooks, and describe how changesets decide versions and drive releases. Related-Task: INTER-781
erayaydin
force-pushed
the
docs/contributing-release-process-inter-781
branch
from
October 7, 2026 15:28
145acd2 to
de4c845
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The Git hook documentation contradicts the repository’s existing optional commit hook and installer.
1 open finding
What changed in this PR
Expands contributor guidance for commit conventions and the SDK release process.
Changes:
- Documents Conventional Commit formats, types, breaking changes, and examples.
- Explains changeset creation, version bumps, and release automation.
- Adds Git hook guidance, though it incorrectly states none exist.
| File | Description |
|---|---|
contributing.md |
Documents commit messages, changesets, and releases. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Document the optional hooks from install_hooks.sh, narrow the changeset criterion to public API or behavior changes, and make the breaking change row cover any <type>! commit. Related-Task: INTER-781
Soften the pre-push hook description, run pnpm install before install_hooks.sh, and clarify that only PRs with changesets open the release PR. Related-Task: INTER-781
erayaydin
marked this pull request as ready for review
October 7, 2026 16:48
erayaydin
requested review from
Orkuncakilkaya,
ilfa,
mcnulty-fp and
necipallef
as code owners
October 7, 2026 16:48
mcnulty-fp
previously approved these changes
Oct 7, 2026
mcnulty-fp
left a comment
mcnulty-fp
left a comment
Contributor
There was a problem hiding this comment.
Looks good! Left just one nit
Replace the commit format details with links to Conventional Commits and the commitlint config, since they are not SDK-specific. Related-Task: INTER-781
Make Git hooks a sibling of the Commit messages heading, since the hooks cover more than commit messages. Related-Task: INTER-781
Contributor
pnpm exec changesetto create a changeset. |
mcnulty-fp
approved these changes
Oct 8, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expands
contributing.mdso contributors know how to write commit messages and how releases are made. This only changes thecontributing.mdfile.Analyze Commit Messagescheck uses.install_hooks.sh(commit-msgruns commitlint,pre-pushtries to stop accidental pushes tomain); commit messages are also checked in CI.Release [changeset]PR, tag, publish to JitPack).