Skip to content

Commit f8acd99

Browse files
author
Amanda Butler
authored
Edit workflow.md
Edit file, mostly for complete sentences and parallelism.
1 parent efc2e0b commit f8acd99

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Release: patch
8282

8383
#### Refactor
8484

85-
A refactor is a contribution that modifies the codebase without fixing a bug or changing the existing behavior. Examples of this would be moving functions or variables between translation units, renaming source files or folders, scope modification for nonpublic code, documentation structure changes, and test organization changes. There is always the risk that someone depended on the location or name before a refactor; therefore, these are lower in priority than bug fixes and might require detailed justification for the change. Refactors are candidates for feature releases.
85+
A refactor is a contribution that modifies the codebase without fixing a bug or changing the existing behavior. Examples of this are moving functions or variables between translation units, renaming source files or folders, scope modification for nonpublic code, documentation structure changes and test organization changes. There is always the risk that someone depended on the location or name before a refactor; therefore, these are lower in priority than bug fixes and might require detailed justification for the change. Refactors are candidates for feature releases.
8686

8787
Release: feature
8888

@@ -94,16 +94,17 @@ Release: patch
9494

9595
#### Functionality change
9696

97-
Any change in the functionality, it can be adding a new feature, adding a new method or a function. Software language does not matter.
97+
A functionality change can be any change in the functionality, including adding a new feature, a new method or a function. Software language does not matter.
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

101101
Every pull request changing or adding functionality must contain a release notes section called "Release notes" to describe the changes to users.
102102

103103
It must contain:
104-
- brief description of changes introduced
105-
- impact analysis - identify components affected, what are potential consequences for users, why do we need this
106-
- migration guidance: actions for updating the current code. Good to include code snippets to illustrate, before/after
104+
105+
- A brief description of changes introduced.
106+
- An impact analysis: components affected, potential consequences for users and reasons for the addition or change.
107+
- Migration guidance: actions for updating the current code. Please include code snippets to illustrate before and after the addition or change.
107108

108109
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.
109110

@@ -177,16 +178,16 @@ If a pull request is idle for more than two weeks, it will be closed. The author
177178

178179
#### Reviews
179180

180-
All pull requests must be reviewed. The Arm Mbed CI bot determines the most suitable person to review the pull request (based on the files changed) and tags that person accordingly. Specific, a PR creator can request reviewers by @ tagging people or teams in the *Reviewers* section of the pull request template. For example, @personA @TeamB.
181+
All pull requests must be reviewed. The Arm Mbed CI bot determines the most suitable person to review the pull request (based on the files changed) and tags that person accordingly. A PR creator can request specific reviewers by @ tagging people or teams in the *Reviewers* section of the pull request template. For example, @personA @TeamB.
181182

182183
GitHub dismisses a reviewer's status after any change to the pull request commit history (such as adding a new commit or rebasing). Smaller changes, such as documentation edits or rebases on top of latest master, only require additional review by maintainers. Their approval is sufficient because a team assigned as a reviewer already approved the pull request.
183184

184185
Label: `needs: review`
185186
Time: 3 days for reviewers to leave feedback after the maintainers add the "needs: review" label.
186187

187-
#### The CI (Continuous Integration) testing
188+
#### The Continuous Integration (CI) testing
188189

189-
There are many [CI systems available](../contributing/workflow.html#guidelines-for-github-pull-requests) for testing Mbed OS pull requests and braches. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request.
190+
There are many [CI systems available](../contributing/workflow.html#guidelines-for-github-pull-requests) for testing Mbed OS pull requests and braches. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all-green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request.
190191

191192
Label: `needs: CI`
192193
Time: 1 day for CI to complete and report back results.

0 commit comments

Comments
 (0)