Merge remote-tracking branch 'origin/code-style-review-instructions' into integration_2024_w21c

CONTRIBUTING.md

@@ -5,22 +5,26 @@ We want to make contributing to this project as easy and transparent as possible
 Please refer to the steps described on our website: [How to contribute to OAI](https://www.openairinterface.org/?page_id=112).
 
 1. Sign and return a Contributor License Agreement to OAI team.
-2. Register on [Eurecom GitLab Server](https://gitlab.eurecom.fr/users/sign_up) if you do not have any.
+2. Register on [Eurecom GitLab Server](https://gitlab.eurecom.fr/users/sign_up)
+   if you do not have any.
    - We recommend that you register with a professional or student email address.
-   - If your email domain (`@domain.com`) is not whitelisted, please contact us (mailto:contact@openairinterface.org).
+   - If your email domain (`@domain.com`) is not whitelisted, please contact us
+     (mailto:contact@openairinterface.org).
    - Eurecom GitLab does NOT accept public email domains.
-3. Provide the OAI team with the **username** of this account to (mailto:contact@openairinterface.org) ; we will give you the developer rights on this repository.
-4. The policies are described in these wiki pages: [OAI Policies](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home).
-   - PLEASE DO NOT FORK the OAI repository on your own Eurecom GitLab account. It just eats up space on our servers.
-   - You can fork onto another hosting system. But we will NOT accept a merge request from a forked repository.
+3. Provide the OAI team with the **username** of this account to
+   (mailto:contact@openairinterface.org) ; we will give you the developer
+   rights on this repository.
+4. The contributing policies are described in the [corresponding documentation
+   page](doc/code-style-contrib.md).
+   - PLEASE DO NOT FORK the OAI repository on your own Eurecom GitLab account.
+     It just eats up space on our servers.
+   - You can fork onto another hosting system. But we will NOT accept a merge
+     request from a forked repository.
       * This decision was made for the license reasons.
       * The Continuous Integration will reject your merge request.
-   - All merge requests SHALL have `develop` branch as target branch.
 
-## Coding Styles ##
+# License #
 
-There are described [here](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/guidelines/guidelines-home).
-
-## License ##
-
-By contributing to OpenAirInterface, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.
+By contributing to OpenAirInterface, you agree that your contributions will be
+licensed under the license described in the file [`LICENSE`](./LICENSE) in the
+root directory of this source tree.

doc/README.md

@@ -19,6 +19,7 @@
 - [FEATURE_SET.md](./FEATURE_SET.md): lists supported features
 - [GET_SOURCES.md](./GET_SOURCES.md): how to download the sources
 - [BUILD.md](./BUILD.md): how to build the sources
+- [code-style-contrib.md](./code-style-contrib.md): overall working practices, code style, and review process
 - [cross-compile.md](./cross-compile.md): how to cross-compile OAI for ARM
 - [clang-format.md](./clang-format.md): how to format the code
 - [sanitizers.md](./dev_tools/sanitizers.md): how to run with ASan/UBSan/MemSAN/TSan
@@ -51,9 +52,11 @@ There is some general information in the [OpenAirInterface Gitlab Wiki](https://
 - [How to run with E2 agent](../openair2/E2AP/README.md)
 
 Legacy unmaintained files:
-- `L2NFAPI_NOS1.md`, `L2NFAPI_S1.md`: old L2simulator, not valid anymore
-- `SystemX-tutorial-design.md`
-- `UL_MIMO.txt`
+- [`L2NFAPI_NOS1.md`](./L2NFAPI_NOS1.md), [`L2NFAPI_S1.md`](./L2NFAPI_S1.md):
+  old L2simulator, not valid anymore
+- [`SystemX-tutorial-design.md`](./SystemX-tutorial-design.md): old, high-level
+  documentation
+- [`UL_MIMO.txt`](./UL_MIMO.txt): UL-MIMO specific notes
 
 # Designs
 
@@ -65,7 +68,7 @@ Legacy unmaintained files:
 - [L1 threads in NR-UE](./nr-ue-design.md)
 
 Legacy unmaintained files:
-- 5Gnas.md
+- [`5Gnas.md`](./5Gnas.md)
 
 # Building and running from images
 
@@ -73,7 +76,7 @@ Legacy unmaintained files:
 - [How to run 5G with the RFsimulator from images](../ci-scripts/yaml_files/5g_rfsimulator/README.md)
 - [How to run 4G with the RFsimulator from images](../ci-scripts/yaml_files/4g_rfsimulator_fdd_05MHz/README.md)
 - [How to run 5G with the L2simulator from images](../ci-scripts/yaml_files/5g_l2sim_tdd/README.md)
-- [How to run images in OpenShift](../openshift/README.md)
+- [How to run physical simulators in OpenShift](../openshift/README.md)
 
 # Libraries
 
@@ -87,7 +90,7 @@ Legacy unmaintained files:
 - The [threadpool](../common/utils/threadPool/thread-pool.md) used in L1
 - The [LDPC implementation](../openair1/PHY/CODING/DOC/LDPCImplementation.md) is a shared library
 
-## SDRs
+## Radios
 
 Some directories under `radio` contain READMEs: