... | ... | @@ -19,6 +19,8 @@ |
|
|
1. [Creation of a feature branch](#21-creation-of-a-feature-branch)
|
|
|
2. [Committing](#22-committing)
|
|
|
3. [Pushing into the central repository](#23-pushing-into-the-central-repository)
|
|
|
4. [Contributing to the develop branch](#24-contributing-to-the-main-branch-aka-develop)
|
|
|
5. [Contributing to testing](#25-contributing-to-testing)
|
|
|
3. [Bug-fix branches](#3-bug-fix-branches)
|
|
|
4. [Inactives branches](#4-inactives-branches)
|
|
|
|
... | ... | @@ -127,6 +129,36 @@ For their work to be easier, it is strongly recommended that feature branches de |
|
|
|
|
|
It will also allow CI administrator(s) to prepare the integration of new tests to validate the new feature(s).
|
|
|
|
|
|
## 2.5. Contributing to Testing ##
|
|
|
|
|
|
You are adding code / feature to the OAI project. Nice but that's half the work! **Feature without testing is no feature.**
|
|
|
|
|
|
The Continuous Integration process **DO** prevent new contributions to:
|
|
|
|
|
|
* Break existing features that are tested by the current test-suite
|
|
|
* Degradate existing features' performances that are measured by the current test-suite
|
|
|
|
|
|
But the CI process **DOES NOT** prevent other contributors to:
|
|
|
|
|
|
* Break / Degradate your brand new merged feature(s)
|
|
|
* **If you don't contribute to the CI test suite**
|
|
|
|
|
|
Testing your brand new feature can be done several ways:
|
|
|
|
|
|
* Unit-level testing: a little program is build and auto-tests itself
|
|
|
* There are several simulator-based frameworks
|
|
|
* There is a Python-based framework when testing with COTS (real) UEs
|
|
|
|
|
|
You should ask yourselves the best way to test your new feature(s).
|
|
|
|
|
|
In any case, you should communicate with the OAI CI team in order to have your tests included in the official OAI CI test-suite.
|
|
|
|
|
|
You should provide (the list is not exhaustive):
|
|
|
|
|
|
* Build variant to use (in another words, which option(s) to use)
|
|
|
* Server configuration
|
|
|
* Do you need equipement?
|
|
|
|
|
|
# 3. Bug-fix branches #
|
|
|
|
|
|
Bug-fix branches are very much like release branches in that they are also meant to prepare for a new production release, albeit unplanned.
|
... | ... | |