...
| types |
|---|
| feat (for feature) |
| fix |
| docs |
| style |
| refactor |
| perf |
| test |
| build |
| ci |
| revert |
| common |
| scope |
|---|
| core-data or data |
| core-command or command or cmd |
| core-metadata or metadata or meta |
| snap |
| docker |
| security |
| scheduler |
| notifications |
| sma |
| deps (for dependencies) |
| all (applying to all services) |
Examples of proper messages (in the context of sample Git CLI commands) are:
...
If you do not provide type in your commit message, an automated GitHub bot will flag your pull request and it will fail its checks. When your pull request has failed checks, it cannot be merged until the problem is corrected. If you do not provide scope, the EdgeX reviewers are expected to flag your pull request and ask that you make a change to provide a scope. Without reviewers approval, your pull request does not pass the reviewer check and it cannot be merged.
The body of the commit should contain a reference to issues that is address (closes and/or fixes). Example:
- git commit -s -m "fix(core-data): fixed some big error description" -m "fixes: #123"
- git commit -s -m "fix(core-data): fixed some big error description" -m "closes: #123"
EdgeX GitHub Getting Started
...