Skip to content

Commit d339ea2

Browse files
committed
Merge branch 'MarceloSalazar-docs-contributing'
2 parents 13abb4c + 42101f6 commit d339ea2

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,50 @@ This should be verified by executing the Pelion E2E python test library tests.
313313

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

316+
## Contributing platform support
317+
318+
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.
319+
Expectations on contributions:
320+
321+
- No code changes in `main.cpp`.
322+
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.
323+
324+
- No changes to the hash of `mbed-os.lib ` or `mbed-cloud-client.lib` files.
325+
The Mbed OS release used in this repository should be update-to-date but you can raise an issue to be updated by the maintainers.
326+
327+
- No extra files or `.mbedignore` with removal of Mbed OS code.
328+
You may need to fix issues and send a PR to [Mbed OS](https://github.com/ARMmbed/mbed-os) first.
329+
330+
- Configuration (required)
331+
- `mbed_app.json` to add components or features. Please follow the guidelines in the porting section of the docs.
332+
333+
- Drivers (optional)
334+
- 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`.
335+
336+
- Bootloader (required)
337+
- The configuration should be provided in either [mbed-bootloader](https://github.com/ARMmbed/mbed-bootloader) repository (as default configuration) or [bootloader](https://github.com/ARMmbed/mbed-os-example-pelion/tree/master/bootloader) folder in this repository (if non-default). Our recommendation is to contribute to the mbed-bootloader repository whenever possible. Please indicate where the bootloader configuration lives.
338+
- Binaries should be generated and contributed following the name conventions in the bootloader folder.
339+
340+
- Indication of platform support
341+
- Please update `README.md` file and add an entry to the list of supported boards.
342+
343+
- Test results and other information
344+
- Attach test logs for required toolchains as documented [here](https://os.mbed.com/docs/mbed-os/latest/tools/index.html)
345+
- Greentea (Mbed OS tests, including integration tests).
346+
- Pelion E2E tests based on pytest.
347+
- Mbed OS and Mbed-cloud-client version used during the tests.
348+
Note contributions will be accepted only against versions available in the example at that time.
349+
350+
- Pull-requests are raised against the master branch. The Arm team makes releases regularly.
351+
352+
- Pelion-Ready. Indicate if a board is expected to be marked as Pelion-Ready and therefore be added to the Pelion Quick-start.
353+
354+
- You agree that the configuration changes contributed are considered open source and Apache 2.0 licensed.
355+
356+
- 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.
357+
358+
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.
359+
316360
# Known-issues
317361

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

0 commit comments

Comments
 (0)