You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
INTER-782: Document commit conventions and release process in contributing.md - #286
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: Optional hooks from install_hooks.sh (commit-msg runs commitlint, pre-commit runs php-cs-fixer, pre-push tries to stop accidental pushes to main); commit messages are also checked in CI.
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 Packagist).
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-782
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-782
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-782
Document preview workflow exception for changeset PRs
contributing.md:188
The preview job does not run on every PR: the reusable workflow skips titles containing [changeset] , including the generated release PR. Documenting that exception keeps the release flow consistent with the workflow's actual condition.
Replace the commit format details with links to Conventional Commits and the commitlint
config, since they are not SDK-specific.
Related-Task: INTER-782
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
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-commitruns php-cs-fixer,pre-pushtries to stop accidental pushes tomain); commit messages are also checked in CI.Release [changeset]PR, tag, publish to Packagist).