Skip to content

Commit c6c56d9

Browse files
committed
workflow: functionality changes release notes addition
Every functionality change must contain release notes text addition. This will be gating functionality change integration. A user does not need to go through PRs to see what has changed, read the section: "Functionality changes" in the release notes.
1 parent 767f3c1 commit c6c56d9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ Any change in the functionality, it can be adding a new feature, adding a new me
9898

9999
A feature contribution contains a new API, capability or behavior. It does not break backward compatibility with existing APIs, capabilities or behaviors. New feature contributions are very welcome in Mbed OS. However, because they add capability to the codebase, it's easy for a new feature to introduce bugs and a support burden. The introduction of new features should also come with documentation, majority of targets support and comprehensive test coverage proving the correctness of the feature per the documentation. Feature PRs are treated cautiously, and new features require a new minor version for the codebase. Features are candidates for feature releases.
100100

101+
Every functionality change pull request must contain release notes section addition to describe the change to users.
102+
103+
It must contain:
104+
- description of changes with impact analysis
105+
- migration guidance: before and after (good to include code snippets to illustrate)
106+
101107
We initially implement new features on separate branches in the Mbed OS repository. Mbed OS maintainers create the new branches by following the naming convention: "feature-" prefix.
102108

103109
Each feature has a tech lead. This person is responsible for:

0 commit comments

Comments
 (0)