|
1 | 1 | # Committing changes to mbedmicro/mbed
|
| 2 | + |
2 | 3 | * Our current branching model is very simple. We are using ```master``` branch to merge all pull requests.
|
3 | 4 | * Based on stable ```SHA``` version of ```master``` branch we decide to release and at the same time ```tag``` our build release.
|
4 | 5 | * Our current release versioning follows simple integer version: ```94```, ```95```, ```96``` etc.
|
@@ -33,10 +34,10 @@ Please send pull requests with changes which are:
|
33 | 34 | * Test results are added.
|
34 | 35 |
|
35 | 36 | After you send us your pull request our Gate Keeper will change the state of pull request to:
|
36 |
| -• ``` enhancement``` or ```bug``` when pull request creates new improvement or fixed issue. |
| 37 | +• ``` enhancement``` or ```bug``` when pull request creates new improvement or fixed issue. |
37 | 38 | Than we will set for you labels:
|
38 |
| -• ```review``` to let you know your pull request is under review and you can expect review related comments from us. |
39 |
| -• ```in progress``` when you pull request requires some additional change which will for now block this pull request from merging. |
| 39 | +• ```review``` to let you know your pull request is under review and you can expect review related comments from us. |
| 40 | +• ```in progress``` when you pull request requires some additional change which will for now block this pull request from merging. |
40 | 41 | At the end we will remove ```review``` label and merge your change if everything goes well.
|
41 | 42 |
|
42 | 43 | ## C++ coding rules & coding guidelines
|
@@ -257,13 +258,13 @@ Please refer to TESTING.md document for detais regarding mbed SDK test suite and
|
257 | 258 |
|
258 | 259 | ## Before pull request checklist
|
259 | 260 | * Your pull request description section contains:
|
260 |
| - * Rationale – tell us why you submitted this pull request. This is your change to write us summary of your change. |
261 |
| - * Description – describe changes you’ve made and tell us which new features / functionalities were implemented. |
262 |
| - * Manual / Cookbook / Handbook – you can put here manual, cookbook or handbook related to your change / enhancement. Your documentation can stay with pull request. |
| 261 | + * Rationale – tell us why you submitted this pull request. This is your change to write us summary of your change. |
| 262 | + * Description – describe changes you’ve made and tell us which new features / functionalities were implemented. |
| 263 | + * Manual / Cookbook / Handbook – you can put here manual, cookbook or handbook related to your change / enhancement. Your documentation can stay with pull request. |
263 | 264 | * Test results (if applicable).
|
264 | 265 | * Make sure you followed project's coding rules and styles.
|
265 | 266 | * No dependencies are created to external C/C++ libraries which are not included already in our repository.
|
266 | 267 | * Please make sure that in your module all functions have unique prefix (no name space collisions).
|
267 |
| -* You reused existing functionality, please do not add or rewrite existing code. E.g. use mbed’s ```FunctionPointer``` if possible to store your function pointers. Do not write another wrapper for it. We already got one. If some functionality is missing, just add it! Extend our APIs wisely! |
| 268 | +* You reused existing functionality, please do not add or rewrite existing code. E.g. use mbed’s ```FunctionPointer``` if possible to store your function pointers. Do not write another wrapper for it. We already got one. If some functionality is missing, just add it! Extend our APIs wisely! |
268 | 269 | * Were you consistent? Please continue using style / code formatting, variables naming etc. in file they are modifying.
|
269 |
| -* Your code compiles and links. Also doesn’t generate additional compilation warnings. |
| 270 | +* Your code compiles and links. Also doesn’t generate additional compilation warnings. |
0 commit comments