Skip to content

Add ReadMe for third party port contributions #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 28, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions portable/ThirdParty/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# FreeRTOS Third Party Ports

FreeRTOS third party ports can be supported by the FreeRTOS team, a FreeRTOS
partner or FreeRTOS community members. Depending on who supports it, the support
provided will differ as follows:

## FreeRTOS Team Supported Third Party FreeRTOS Ports

Location: https://github.com/FreeRTOS/FreeRTOS-Kernel/tree/main/portable/ThirdParty

These third party FreeRTOS ports are supported by the FreeRTOS team. For a
FreeRTOS team supported third party FreeRTOS port:

* The code has been reviewed by the FreeRTOS team.
* FreeRTOS team has access to the hardware and the test results have been
verified by the FreeRTOS team.
* Customer queries as well as bugs are addressed by the FreeRTOS team.

A new FreeRTOS port cannot be directly contributed to this location. Instead,
the FreeRTOS team will decide to take ownership of a partner supported or a
community supported FreeRTOS port based on the community interest.

## Partner Supported FreeRTOS Ports

Location: https://github.com/FreeRTOS/FreeRTOS-Kernel-Partner-Supported-Ports/tree/main

These FreeRTOS ports are supported by a FreeRTOS partner. For a partner
supported FreeRTOS port:

* The code has not been reviewed by the FreeRTOS team.
* FreeRTOS team has not verified the tests results but tests exist and are
reported to be successful by the partner.
* Customer queries as well as bugs are addressed by the partner.
* A new FreeRTOS port can be directly contributed by a partner. The process to
contribute a FreeRTOS port is documented [here](https://github.com/FreeRTOS/FreeRTOS-Kernel-Partner-Supported-Ports/blob/main/README.md).

## Community Supported FreeRTOS Ports

Location: https://github.com/FreeRTOS/FreeRTOS-Kernel-Community-Supported-Ports/tree/main

These FreeRTOS ports are supported by the FreeRTOS community members. For a
community supported FreeRTOS port:

* The code has not been reviewed by the FreeRTOS team.
* Tests may or may not exist for the FreeRTOS port.
* Customer queries as well as bugs are addressed by the community.
* A new FreeRTOS port can be directly contributed by anyone. The process to
contribute a FreeRTOS port is documented [here](https://github.com/FreeRTOS/FreeRTOS-Kernel-Community-Supported-Ports/blob/main/README.md).