Skip to content

Commit ae363eb

Browse files
committed
workflow: add 3rd party updates as an exception
Updates like MbedTLS might contain more than just a bugfix. To keep it simple, they should be sent as one PR - version update. Splitting this type of updates makes it difficult to maintain. It should be stated what version we are getting and a reference to release notes (changelog could be - what this brings in).
1 parent d14b90b commit ae363eb

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/contributing/guidelines/workflow.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ Pull requests on GitHub have to meet the following requirements to keep the code
5252
- All new features and enhancements require documentation, tests and user guides for us to accept them. Please link each pull request to all relevant documentation and test pull requests.
5353
- Avoid merging commmits. (Always rebase when possible.)
5454
- Comment in the pull request on every change (rebase or new commits). This helps reviewers to be up to date with changes
55-
- Pull requests should fix a bug, add a feature or refactor.
55+
- Pull requests should fix a bug, add a feature or refactor.
56+
The only exception are third-party version updates (for instance MbedTLS or Nanostack releases for Mbed OS). These updates should provide release notes for updated version with documentation (a reference to external changelog or release notes).
5657
- Smaller pull requests are easier to review and faster to integrate. Use dependencies – split your work by pull request type or functional changes. To add a third-party driver, send it in a separate pull request, and add it as a dependency to your pull request.
5758

5859
If commits do not follow the above guidelines, we may request that you modify the commit history (often to add more details to address _what_ and _why_ rather than _how_).

0 commit comments

Comments
 (0)