We use a modified version of conventional commits for pull requests to our SDK repos.
As we squash our merges, only your PR title needs to contain the relevant prefix. Here are some examples of PR titles that we’ve used previously:
feat: Implement Phone Validation for Nolchore: Enable local running of fastlane android buildSupported Prefixes
| Commit Type | Title | Description | Versioning |
|---|---|---|---|
feat |
Features | A new feature | MINOR update e.g. 0.1.0 → 0.2.0 |
fix |
Bug Fixes | A bug Fix | PATCH update e.g. 0.1.0 → 0.1.1 |
docs |
Documentation | Documentation only changes | |
style |
Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | |
refactor |
Code Refactoring | A code change that neither fixes a bug nor adds a feature | |
perf |
Performance Improvements | A code change that improves performance | |
test |
Tests | Adding missing tests or correcting existing tests | |
build |
Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | |
ci |
Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | |
chore |
Chores | Other changes that don't modify src or test files | |
revert |
Reverts | Reverts a previous commit | |
BREAKING CHANGE |
Breaking changes | Introduces breaking change | BREAKING update e.g. 0.1.0 → 1.-.0 |