PeriphDrivers – Any changes in msdk/Libraries/PeriphDrivers
ThirdParty – Any third-party library changes (e.g. FreeRTOS, LVGL, lwIP)
MAXUSB – Any MAXUSB changes
SDHC – Any SDHC changes
Build – Any changes involving the build system
ignore – Small and quick miscellaneous fixes (should not be used often)
workflow – Any GitHub workflow-related changes
Other – Any changes that may not fit in the other scopes
NOTE: The scope is case-sensitive and must match one of the listed scopes.
Subject Rules
Use the imperative mood in the Subjects - meaning the tone of the Subject should be like giving an order or request.
The Subject should have useful and concise wording.
The Subject should include what parts are affected in numerical order, if any. Only the parts’ CHIP NAME should be used in the Subject. No die names are allowed.
If the PR title is related to a Jira ticket or an issue, the Subject should begin with the ticket designation.
The first letter must be capitalized and the subject must not end with any punctuation.
More Info
Please refer to the CONTRIBUTING.md for more information regarding the PR Title.
The link to the user guide was broken. Updating it with the new link.
Pull Request Template
Description
Please include a summary of the changes and related issues. Please also include relevant motivation and context.
Checklist Before Requesting Review
PR Title Guidelines
The MSDK repo follows a custom rule set based on the Conventional Commits standard. The pull request titles will follow this format:
type(scope)<!>: Subject
Types
The list of possible types are:
Appending an
!
at the end of the title prefix signifies the PR is a breaking or major change. The <!> is optional in the PR format.NOTE: The type is case-sensitive and must match one of the listed types.
Scopes
The scopes are dependent on the changes based on their location in the MSDK. The list of possible scopes are:
NOTE: The scope is case-sensitive and must match one of the listed scopes.
Subject Rules
More Info
Please refer to the CONTRIBUTING.md for more information regarding the PR Title.