Skip to content

Commit 52c8859

Browse files
committed
workflow: every change should result in a comment
1 parent e2dc14e commit 52c8859

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Pull requests on GitHub have to meet the following requirements to keep the code
5959
- Prefixing your commit message with a domain is acceptable, and we recommend doing so when it makes sense. However, prefixing one's domain with the name of the repo is not useful. For example, making a commit entitled "mbed-drivers: Fix doppelwidget frobulation" to the `mbed-drivers` repo is not acceptable because it is already understood that the commit applies to `mbed-drivers`. Renaming the commit to "doppelwidget: Fix frobulation" would be better, if we presume that "doppelwidget" is a meaningful domain for changes, because it communicates that the change applies to the doppelwidget area of `mbed-drivers`.
6060
- 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 testing pull requests.
6161
- Avoid merging commmits. (Always rebase when possible.)
62+
- Comment in the pull request on every change (rebase or new commits). This helps reviewers to be up to date with changes
6263
- Pull requests should fix a bug, add a feature or refactor.
6364

6465
#### Release versioning

0 commit comments

Comments
 (0)