Skip to content

Commit 1817345

Browse files
author
Amanda Butler
authored
Edit workflow.md
Edit file, mostly for active voice, consistent person and correct grammar.
1 parent 73c85ca commit 1817345

File tree

1 file changed

+25
-32
lines changed

1 file changed

+25
-32
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -158,43 +158,34 @@ Each feature has a Mbed OS technical lead. This person is responsible for:
158158

159159
This is for breaking changes and should be rare. A breaking change is any change that results in breaking user space. It should have strong justification for us to consider it. Often, such changes can be backward compatible, for example, deprecating the old functionality and introducing the new replacement.
160160

161-
A contribution containing a breaking change is the most difficult PR to get merged. Any breaking changes in a codebase can have a large negative impact on any users of the codebase. Breaking changes are always limited to a major version release.
161+
A contribution containing a breaking change is the most difficult PR to get merged. Any breaking changes in a codebase can have a large negative effect on any users of the codebase. Breaking changes are always limited to a major version release.
162162

163163
A project technical lead and the Mbed OS technical lead must approve breaking change pull requests.
164164

165-
166165
### Test results
167166

168-
This section is to indicate what test results if any are required for the PR.
169-
The three options are :
170-
* No Tests required for this change (E.g docs only update)
171-
* Changes will be tested by existing mbed-os tests (Greentea or Unittest)
172-
* Tests / results will supplied as part of this PR. For this option the test results and/or tests
173-
should be posted in this section below the tick boxes.
167+
This section is to indicate what test results, if any, are required for the PR. The three options are:
168+
169+
- No tests required for this change (for example, a documentation-only update).
170+
- Changes will be tested by existing `mbed-os` tests (Greentea or Unittest).
171+
- Tests and results will be supplied as part of this PR. For this option, post the tests and test results
172+
below the tick boxes.
174173

175174
### Reviewers
176175

177-
Reviewers are automatically added by a bot based on the files that are actually changed, however this section
178-
gives the author the option to specify additional, specific reviewers. Required reviewers should be tagged here. E.g. @adbridge, @0xc0170
179-
176+
A bot automatically adds reviewers based on the files that are actually changed. However, this section gives you the option to specify additional, specific reviewers. Tag required reviewers here, such as @adbridge, @0xc0170.
180177

181178
### Release Notes
182179

183-
Every pull request changing or adding functionality must fill in the "Release notes" section. Consequently
184-
this applies to feature and major PRs. For both these types the 'Summary of changes' section must be
185-
completed. This should provide a brief description of changes introduced, including justification.
180+
Every pull request changing or adding functionality must fill in the "Release notes" section. This applies to feature and major PRs. For both these types, you must complete the "Summary of changes" section. Provide a brief description of changes introduced, including justification.
186181

187-
For major PRs is is also compulsory to complete the 'Impact of changes' and 'Migration actions required'.
182+
For major PRs, it is also compulsory to complete the "Impact of changes" and "Migration actions required".
188183

189184
The impact of changes must contain an analysis of effects: components affected and potential consequences for users.
190185

191-
The migration actions required should describe how to migrate from a previous version of the code being
192-
changed to the new version. Please include code snippets to illustrate before and after the addition or
193-
change.
194-
195-
The release notes section is automatically pulled into the overall release notes for a feature or major
196-
release and this should be considered when writing the entries.
186+
The migration actions required should describe how to migrate from a previous version of the code being changed to the new version. Please include code snippets to illustrate before and after the addition or change.
197187

188+
The release notes section is automatically pulled into the overall release notes for a feature or major release. This should be considered when you write the entries.
198189

199190
## GitHub pull requests workflow
200191

@@ -216,41 +207,43 @@ All pull requests must be reviewed. The Arm Mbed CI bot determines the most suit
216207

217208
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.
218209

219-
Label: `needs: review`
220-
Time: Three days for reviewers to leave feedback after the maintainers add the label.
210+
- Label: `needs: review`.
211+
- Time: Three days for reviewers to leave feedback after the maintainers add the label.
221212

222213
### The Continuous Integration (CI) testing
223214

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

226-
- Label: `needs: CI`
217+
- Label: `needs: CI`.
227218
- Time: One day for CI to complete and report back results.
228219

229220
### Work needed
230221

231222
A pull request in the "work needed" state requires additional work due to failed tests, or rework as a result of the review. If a pull request is in this state, our maintainers request changes from the pull request author.
232223

233-
- Label: `needs: work`
224+
- Label: `needs: work`.
234225
- Time: Three days for the pull request author to action the review comments.
235226

236227
### Ready for integration
237228

238229
Maintainers merge pull requests during the internal gatekeeping meetings that occur three times a week. They can merge straightforward pull requests immediately.
239230

240-
- Label: `Ready for merge`
241-
- Time: Two days
231+
- Label: `Ready for merge`.
232+
- Time: Two days.
242233

243234
### Releases
244235

245236
When we merge a pull request that we will publish in a patch release, we tag it with the specific patch release version. This is the release in which we first publish this pull request. For patch releases, we allow only bug fixes, new targets and enhancements to existing functionality. New features are only published in feature releases.
246237

247-
The release tag has the following format:
238+
The release tag has the format:
239+
240+
*release-version: m.f.p*
248241

249-
*release-version: m.f.p* Where:
242+
Where:
250243

251-
* `m` is the major release
252-
* `f` is the feature release
253-
* `p` is the patch release.
244+
- `m` is the major release.
245+
- `f` is the feature release.
246+
- `p` is the patch release.
254247

255248
From time to time there may be additional suffixes added which could represent a release candidate or
256249
alpha/beta release etc

0 commit comments

Comments
 (0)