Skip to content

Commit 6792447

Browse files
author
Marcelo Salazar
authored
Tweak contributing docs as per feedback
1 parent 869e4b0 commit 6792447

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -314,12 +314,13 @@ The contribution of platform support to this repository is restricted to Arm Mbe
314314
Expectations on contributions:
315315

316316
- 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
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.
318318

319319
- 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.
320+
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.
321321

322322
- No extra files or `.mbedignore` with removal of Mbed OS code.
323+
You may need to fix issues and send a PR to [Mbed OS](https://github.com/ARMmbed/mbed-os) first.
323324

324325
- Configuration (required)
325326
- `mbed_app.json` to add components or features. Please follow the guidelines in the porting section of the docs.
@@ -328,22 +329,25 @@ These are maintained and updated by the Arm team.
328329
- 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`.
329330

330331
- 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).
332+
- 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 whether possible. Please indicate where the bootloader configuration lives.
333+
- Binaries should be generated and contributed following the name conventions in the bootloader folder.
333334

334335
- Indication of platform support
335336
- Please update `README.md` file and add an entry to the list of supported boards.
336337

337338
- Test results and other information
338339
- 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+
- Greentea (Mbed OS tests, including integration tests)
340341
- Pelion E2E tests based on pytest
341342
- Mbed OS and Mbed-cloud-client version used during the tests.
342343
Note contributions will be accepted only against versions available in the example at that time.
343344

344345
- Pull-requests are raised against the master branch. The Arm team makes releases regularly.
346+
345347
- Pelion-Ready. Indicate if a platform is expected to be marked as Pelion-Ready and therefore be added to the Pelion Quick-start
346348

349+
- You agree that the configuration changes contributed are considered open source and Apache 2.0 licensed.
350+
347351
- 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.
348352

349353
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.

0 commit comments

Comments
 (0)