Specify the contribution process
Add additional requirements in contribution process to require
contributors to specify maintainers.
Build up a new structure in readme to enable contributors to fill
details and maintainers.
Signed-off-by: David Hu <david.hu@arm.com>
Change-Id: Ib7fda6d0ccdc562c3fc3f8cb94ea2089910fa03a
diff --git a/examples/examples_readme.rst b/examples/examples_readme.rst
index a737920..3aba38a 100755
--- a/examples/examples_readme.rst
+++ b/examples/examples_readme.rst
@@ -2,9 +2,33 @@
Examples
########
-(The list and simple introduction of the examples in this folder)
+The list and simple introduction of the examples in this folder.
-* DMA-350 Secure tests
-* Non-secure DMA-350 examples for the Corstone-310 FVP platform
+corstone310_fvp_dma
+===================
+
+Description
+-----------
+
+* DMA-350 Secure tests
+* Non-secure DMA-350 examples for the Corstone-310 FVP platform
+
+Maintainers
+-----------
+- Bence Balogh `<bence.balogh@arm.com> <bence.balogh@arm.com>`_
+- Mark Horvath `<mark.horvath@arm.com> <mark.horvath@arm.com>`_
+
+extra_test_suites
+=================
+
+Description
+-----------
+An example and template of out-of-tree build of extra regression test suites.
+
+Maintainers
+-----------
+Jianliang Shen `<jianliang.shen@arm.com> <jianliang.shen@arm.com>`_
+
+---------------------------
*Copyright (c) 2021-2022, Arm Limited. All rights reserved.*
diff --git a/partitions/partitions_readme.rst b/partitions/partitions_readme.rst
index 024e3c9..d0b4d3b 100755
--- a/partitions/partitions_readme.rst
+++ b/partitions/partitions_readme.rst
@@ -2,8 +2,20 @@
Partitions
##########
-(The list and simple introduction of the secure partitions in this folder)
+The list and simple introduction of 3rd-party Secure Partitions in this folder.
-* DMA-350 Example unprivileged partition
+dma350_upriv_partition
+======================
+
+Description
+-----------
+DMA-350 Example unprivileged partition
+
+Maintainers
+-----------
+- Bence Balogh `<bence.balogh@arm.com> <bence.balogh@arm.com>`_
+- Mark Horvath `<mark.horvath@arm.com> <mark.horvath@arm.com>`_
+
+---------------------------
*Copyright (c) 2021-2022, Arm Limited. All rights reserved.*
diff --git a/readme.rst b/readme.rst
index aaa67f7..e29847c 100755
--- a/readme.rst
+++ b/readme.rst
@@ -4,30 +4,80 @@
The Trusted Firmware-M (TF-M) Extras repository is the extension of the TF-M
main repository to host the examples, demonstrations, third-party modules,
-thrid-party secure partitions, etc.
+third-party secure partitions, etc.
*******
License
*******
-The default license of new source code in this repository is :doc:`BSD-3 <license>`.
+The default license of new source code in this repository is :doc:`BSD 3-clause <license>`.
Some source files are contributed by the third-parties or derived from the
external projects. A license file should be included in the root folder of these
-source files if it has a different licence.
+source files if it has a different license.
****************
Folder Structure
****************
-- examples - This foloder hosts the examples and demos for TF-M.
-- partitions - This folder hosts the supplementary or third-party secure
-partitions for TF-M.
+- `examples`: This folder hosts the examples and demos for TF-M.
+- `partitions`: This folder hosts the supplementary or third-party secure
+ partitions for TF-M.
*****************************
Contribute to this repository
*****************************
-The `contributing process <https://tf-m-user-guide.trustedfirmware.org/docs/contributing/contributing_process.html>`_ is same as TF-M main repository.
+Refer to `contributing process <https://tf-m-user-guide.trustedfirmware.org/docs/contributing/contributing_process.html>`_
+for the TF-M general contribution guideline.
-*Copyright (c) 2021, Arm Limited. All rights reserved.*
+Please contact `TF-M development mailing list <https://lists.trustedfirmware.org/mailman3/lists/tf-m.lists.trustedfirmware.org>`_
+for any question.
+
+.. note::
+ If your contribution consists of pre-bulit binaries, please upload your
+ binary components to
+ `Trusted Firmware binary repository (tf-binaries) <https://git.trustedfirmware.org/tf-binaries.git/about/>`_.
+ This respository accepts source files only.
+
+Additional requirements
+=======================
+
+- It is expected and strongly recommended to integrate and test your
+ example/secure partition with TF-M latest release, to enable new features and
+ mitigate known security vulnerabilities.
+
+- List the example and secure partition in
+ :doc:`example readme <examples/examples_readme>` and
+ :doc:`secure partition readme <partitions/partitions_readme>` respectively.
+
+ - Each example/secure partition shall specify the following information
+
+ - A brief description
+ - Maintainers with their contact emails
+ - If the example/secure partition is not integrated or tested with the
+ latest TF-M release, specify the TF-M version/commit ID tested with.
+
+ - Each example/secure partition shall follow the structure below
+
+ .. code-block:: rst
+
+ Folder name
+ ===========
+
+ Description
+ -----------
+ Simple description
+
+ Maintainers
+ -----------
+ Maintainer list and emails
+
+ TF-M version
+ ------------
+ Optional. Specify the TF-M version/commit ID if it is not integrated or
+ test with latest TF-M release.
+
+-----------------------
+
+*Copyright (c) 2021-2022, Arm Limited. All rights reserved.*