Skip to content

Commit 869e4b0

Browse files
author
Marcelo Salazar
authored
Update contribution guidalines
1 parent 1f1d102 commit 869e4b0

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,46 @@ This should be verified by executing the Pelion E2E python test library tests.
308308

309309
<span class="notes">**Note:** Future version will bring in also firmware update test as part of the minimum test set.</span>.
310310

311+
## Contributing platform support
312+
313+
The contribution of platform support to this repository is restricted to Arm Mbed Partners and Arm Engineering teams. If you’d like to add a custom or community-based platform, please fork this repository and add it into your own account.
314+
Expectations on contributions:
315+
316+
- No code changes in `main.cpp`.
317+
This is a minimal and generic application that’s expected to work on out of the box with all platforms listed in the documentation and [Pelion Quick-start](https://os.mbed.com/guides/connect-device-to-pelion/) guide
318+
319+
- No changes to the hash of `mbed-os.lib ` or `mbed-cloud-client.lib` files.
320+
These are maintained and updated by the Arm team.
321+
322+
- No extra files or `.mbedignore` with removal of Mbed OS code.
323+
324+
- Configuration (required)
325+
- `mbed_app.json` to add components or features. Please follow the guidelines in the porting section of the docs.
326+
327+
- Drivers (optional)
328+
- If required, drivers for networking or storage (non-default) can be added in the `drivers` folder using an external library (.lib). For example `COMPONENT_MYDRIVER.lib` and enabling in `mbed_app.json`.
329+
330+
- Bootloader (required)
331+
- The configuration should be provided in either [mbed-bootloader](https://github.com/ARMmbed/mbed-bootloader) repository (as default configuration) or bootloader folder in this repository (if non-default). Our recommendation is to contribute to the mbed-bootloader repository whether possible. Please indicate where the bootloader configuration lives.
332+
- Binaries should be generated and contributed following the name conventions (see bootloader folder).
333+
334+
- Indication of platform support
335+
- Please update `README.md` file and add an entry to the list of supported boards.
336+
337+
- Test results and other information
338+
- Attach test logs for required toolchains as documented [here](https://os.mbed.com/docs/mbed-os/latest/tools/index.html)
339+
- Greentea (Mbed OS tests, including integration tests)
340+
- Pelion E2E tests based on pytest
341+
- Mbed OS and Mbed-cloud-client version used during the tests.
342+
Note contributions will be accepted only against versions available in the example at that time.
343+
344+
- Pull-requests are raised against the master branch. The Arm team makes releases regularly.
345+
- Pelion-Ready. Indicate if a platform is expected to be marked as Pelion-Ready and therefore be added to the Pelion Quick-start
346+
347+
- Support of the platform is provided by Silicon Partners or Platform vendors for Mbed Enabled platforms. If using a non-default configuration, then Arm is responsible for its support.
348+
349+
Note platforms will be tested regularly in the Arm CI system. Please discuss with your Arm contact and make hardware available as indicated in the Mbed Enabled requirements.
350+
311351
# Known-issues
312352

313353
Please review existing issues on github and report any problem you may see.

0 commit comments

Comments
 (0)