Overview
This page is to provide detail on the contribution process for CPS.
Joining the ONAP Community
Development Procedures and Policies
Code Repos
- https://gerrit.onap.org/r/admin/repos/cps
- https://gerrit.nordix.org/admin/repos/onap/cps (for Ericsson Software Technology Employees only)
Initial Seed Code Contribution
Code Requirements
- Copyright included in each file. Apache 2 for coding files.
- The Copyright line for contributing organization inserted or updated reflecting the contribution year.
- A LICENSE.txt file placed at the root of the repo to provide umbrella coverage.
- Unit testing coverage > 55% for POC using Groovy & Spock
- We will follow ONAP Recommended Software Development Best Practices: Developer Best Practices
https://jira.onap.org/secure/RapidBoard.jspa?projectKey=CPS&rapidView=228
JIRA Status Updates
Move To | When |
|---|---|
| In-progress | The moment you start working on it. |
| Submitted | The review is merged, merge & CICD jobs are successful. |
| Closed | Documentations are updated. Complete demo to team. |
Committer Strategy
- Each review requires 2 committers to +1 and +2.
- A +2 from committer or PTL have the permissions to merge code.
Merge and +2 committers:
Code Submissions
- Any checkstyle issues must be fixed in current review.
- Code must be covered by tests.
- We are currently in the process of setting up sonarqube to check our code coverage. Please use the sonarqube plugin for now to measure coverage. To setup sonarqube see dev setup guide: Setting Up Your Development Environment#LocalSonarQubeSetup
- Mark the review as WIP if it is not ready for review.
- Commit message must be in the following format:
Comment explaining what is the purpose of the code. Issue-ID: CPS-1 |
Code Analysis
We recommend that most user stories are accompanied with small wiki page to document/clarify some analysis for that user story.
Unit Test
CPS is promoting Groovy and Spock for our unit test. All new modified code should include good quality test
see Groovy & Spock you can also contact the PTL Toine Siebelink for more details
User Story Demos
As part of our best practice to finish a user story it should be demonstrated to team and if possible recorded
Java Code Required Practices
IDEs
Setting Up Your Development Environment#IDEs
Jenkins Job
ONAP uses Jenkins based CICD tool chain. However, contributors are only given read access to the Jenkins servers. All jobs are created by automatic generation from JJB definitions.
https://jenkins.onap.org./view/cps/
Bug reporting
Vulnerability report process
If you find any vulnerability please email the security contact with the information that you have.
The security contact is ; toine.siebelink@est.tech
We will give credit to anyone who reports a vulnerability so that we can fix it. If you wish to remain anonymous instead, please let us know and we will respect that.