INTER-779: Document commit conventions and release process in contributing.md

[erayaydin]

Expands contributing.md so contributors know how to write commit messages and how releases are made. This only changes the contributing.md file.

• Commit messages: links to Conventional Commits and the commitlint config that the Analyze Commit Messages check uses.
• Git hooks: What the husky hooks do (commit-msg, pre-commit, pre-push).
• How to publish: how to add a changeset, how to pick patch/minor/major based on the type of change and what that does to the version, and what happens after merge (Release [changeset] PR, tag, publish to npm).

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5a03d0f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	98.25%	168/171
🟢	Branches	97.03%	98/101
🟢	Functions	100%	37/37
🟢	Lines	98.21%	165/168

Test suite run success

132 tests passing in 30 suites.

Report generated by 🧪jest coverage report action from 5a03d0f

Show full coverage report

St	File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
🟢	All files	98.24	97.02	100	98.21
🟢	src	98.54	98.76	100	98.51
🔴	...edApiTypes.ts	0	0	0	0
🔴	index.ts	0	0	0	0
🟢	sealedResults.ts	100	100	100	100
🟢	...rApiClient.ts	96.15	97.22	100	96.15	360,364
🟢	types.ts	100	100	100	100
🟢	urlUtils.ts	100	100	100	100
🟢	webhook.ts	100	100	100	100
🟢	src/errors	97.05	90	100	96.96
🟢	apiErrors.ts	100	100	100	100
🟢	...orResponse.ts	100	100	100	100
🟢	toError.ts	87.5	88.88	100	87.5	21
🟢	unsealError.ts	100	50	100	100	14

[Copilot]

Note

Copilot was unable to run its full agentic suite in this review.

Copilot review overview

2 open findings

• The table uses double leading pipes (||), which won’t render as a standard Markdown table on… · New
• Same Markdown table formatting issue here: rows start with ||, which prevents proper rendering on… · New

What changed in this PR

Updates contributor documentation to clarify commit message conventions and the changeset-based release process.

Changes:

• Document Conventional Commits usage (types, scopes, breaking changes) and local Git hooks.
• Expand changesets guidance with examples, bump mapping, and release flow steps.

File	Description
contributing.md	Adds detailed commit message and changeset/release process guidance for contributors.

🧠 Review effort: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

🔵 Needs a closer look

Two documentation details inaccurately describe the project’s generator and release workflow.

0 open findings

2 resolved since last review

• Same Markdown table formatting issue here: rows start with ||, which prevents proper rendering on…
• The table uses double leading pipes (||), which won’t render as a standard Markdown table on…

Previously missed (2)

In code that hasn't changed since last review

Update example references the wrong OpenAPI generator

contributing.md:61

This update example names openapi-generator, but this SDK's generation script imports openapi-typescript and package.json declares only openapi-typescript. Using the absent tool as a repository-specific example may send contributors toward the wrong dependency; use the generator actually used by this project.

Release workflow skips PRs when merged changes lack changesets

contributing.md:200

The release workflow does not open or update a release PR after every merged PR: the reusable workflow first checks for pending changesets and only takes the PR path when they exist. As written, this incorrectly promises a release PR even after docs/internal PRs that correctly omit a changeset.

🧠 Review effort: Balanced

[github-actions]

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm exec changeset

to create a changeset.