From e7596f9bd574dbbd932446f03e3806ff5c371194 Mon Sep 17 00:00:00 2001 From: Robert Schmidt Date: Wed, 22 May 2024 08:44:01 +0200 Subject: [PATCH] Clarify CONTRIBUTING.md and wrap text to 80 columns --- CONTRIBUTING.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73886f3f7e..7b2f081988 100644 --- a/CONTRIBUTING.md +++ b/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.