Skip to content

Commit 0003157

Browse files
committed
workflow: fix impact analysis vs description
1 parent c6c56d9 commit 0003157

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,11 @@ 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.
101+
Every functionality change pull request must contain a release notes section called "Release notes" to describe the changes to users.
102102

103103
It must contain:
104-
- description of changes with impact analysis
104+
- brief description of changes introduced
105+
- impact analysis - identify components affected, what are potential consequences for users, why do we need this
105106
- migration guidance: before and after (good to include code snippets to illustrate)
106107

107108
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.

0 commit comments

Comments
 (0)