You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Code Contribution Workflow
Code Contribution Workflow Diagram
- User will do code contribution to rdk-next branch. This will undergo:
- Code reviews
- Build verification
- License compliance scan
- Test validation
- Once successful, the change will get cherry-picked to Monthly Sprint Branch (rdk-dev-yymm)
- This code is then down-streamed to Regression Branch where pre-deployment test validation are done
- Once Comcast accepts, the change-set is cherry picked to Product Branch.
- Thus the change gets merged to Product Branch
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlotWW9nb21heWEgTWFoYXJhbmEiLCJvdXRwdXRUeXBlIjoiYmxvY2siLCJsYXN0TW9kaWZpZXJOYW1lIjoiWi1Zb2dvbWF5YSBNYWhhcmFuYSIsImxhbmd1YWdlIjoiZW4iLCJ1aUNvbmZpZyI6Int9IiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiMTQ0OTAwOTc4IiwiZGlhZ3JhbU5hbWUiOiJDb2RlIENvbnRyaWJ1dGlvbiBXb3JrLUZsb3cuZHJhd2lvIiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IkNvZGUgQ29udHJpYnV0aW9uIFByb2Nlc3MiLCJ0YnN0eWxlIjoidG9wIiwiY2FuQ29tbWVudCI6ZmFsc2UsImRpYWdyYW1VcmwiOiIiLCJjc3ZGaWxlVXJsIjoiIiwiYm9yZGVyIjp0cnVlLCJtYXhTY2FsZSI6IjEiLCJvd25pbmdQYWdlSWQiOjkwMTE3MDMzLCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjo5MDExNzAzMywicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MSwibWFjcm9JZCI6IjJmMmYyYWVkLTIwMTgtNDIwNS05OWQ0LTFlNzc1ZjU2ZmUxMCIsInByZXZpZXdOYW1lIjoiQ29kZSBDb250cmlidXRpb24gV29yay1GbG93LmRyYXdpby5wbmciLCJsaWNlbnNlU3RhdHVzIjoiT0siLCJzZXJ2aWNlIjoiIiwiaXNUZW1wbGF0ZSI6IiIsIndpZHRoIjoibnVsbCIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTYxNDY5NDU0NTAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
Component owners/reviewers/approvers, defined as specific groups in Gerrit, will be added to the review by default. You may request additional feedback by specifically adding reviewers via the Gerrit web GUI.
Product Branch
Product branch is a deployment ready branch is created for RDK components that the community will push changes to review.
Refer to Product Branch for the Components hosted in CMF Gerrit (https://code.rdkcentral.com)
Refer to RDK Central GitHub Components & its Branches hosted in https://github.com/rdkcentral/
Monthly Sprint Branch
Monthly Sprint Branch (rdk-dev-yymm) is a new CMF integration branch, created monthly and baseline off Product Branch. This branch will be hosted per repository in conjunction with Product branch with the goal of incorporating community changes at the earliest juncture.
Once community changes is approved, will be cherry-picked to Monthly Sprint branch (rdk-dev-yymm) and will thus be available prior to the completion of down-streaming to Regression Branch / round-trip process.
Regression Branch
Regression branch is the branch used for validation of the contributions. Approved contributions will be down-streamed to Regression Branch for pre-deployment validation using their test process.
- Defects will be planned in monthly sprints
- Features will be presented for Architecture Review to be scheduled to an upcoming sprint. Sprint timelines to be published to contributor.
- Contributions pending validation will be available in monthly development iteration branches
Down streamed Community changes, successfully merged to Regression branch, after pre-deployment test validation, the code changes will be cherry-picked to Product Branch.
Code Submission Process
Code Submission Process - RDK Central Gerrit
Code Submission Process - RDK Central GitHub
This document describes the general RDK development work-flow and related topics.
Code Management Facility (CMF)
On a periodic basis, RDK code is tested and released to the community as CMF releases. This will be generic RDK code without dependency to any platform. CMF code can be built for emulator or raspberry-pi or can be ported to a specific platform (RDK Porting).
Routine Releases
- Tagged every two weeks
- Built and tested
- Only tagged if Black Duck, Build and Test successful
- Changes pulled from Comcast every two weeks
CMF Contributions
While working with CMF stack, one might find ways to enhance RDK code by adding new features or bug fixes as RDK contribution. The general CMF contribution workflow is as follows:
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlotWW9nb21heWEgTWFoYXJhbmEiLCJvdXRwdXRUeXBlIjoiYmxvY2siLCJsYXN0TW9kaWZpZXJOYW1lIjoiWi1Zb2dvbWF5YSBNYWhhcmFuYSIsImxhbmd1YWdlIjoiZW4iLCJ1aUNvbmZpZyI6Int9IiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiMTQ0OTAwOTY2IiwiZGlhZ3JhbU5hbWUiOiJDTUYgQ29udHJpYnV0aW9ucy5kcmF3aW8iLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiUkRLLVYgRGV2ZWxvcG1lbnQgV29ya2Zsb3ciLCJ0YnN0eWxlIjoidG9wIiwiY2FuQ29tbWVudCI6ZmFsc2UsImRpYWdyYW1VcmwiOiIiLCJjc3ZGaWxlVXJsIjoiIiwiYm9yZGVyIjp0cnVlLCJtYXhTY2FsZSI6IjEiLCJvd25pbmdQYWdlSWQiOjIzNTkzODU3LCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjoyMzU5Mzg1NywicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MSwibWFjcm9JZCI6Ijg3OTUzZmQyLTk1MTctNDRhMS1hM2MwLWU3NTc2ZGEyOWJkNSIsInByZXZpZXdOYW1lIjoiQ01GIENvbnRyaWJ1dGlvbnMuZHJhd2lvLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiJudWxsIiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNjE0Njk0NTQ0MDAwLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==
Detailed information on contributing code changes to RDK can be found here: Code Management Documentation
Getting Support
Support tickets can be raised to get request support from RDK Community Support team. This can be for the bugs you faced, doubts you have or any code contributions which you think might enhance RDK.
RDK Support ticket can be raised here: https://jira.rdkcentral.com/jira
Categories of support tickets are:
Issue type | Name | Description |
---|
General Support Issues | RDK_JIRA_<Company_Name> | Raise a JIRA ticket in your Company Specific Project. This project is accessible only to Preferred member companies. |
Code Management Facility Support | RDKCMF | Code contributions to CMF as part of bug fixing or feature enhancement comes under this category. Updating of code from RDK to CMF is also tracked in these. |
RDK Support | RDK | Anybody with RDK Support credentials can create this category of tickets. |
Raspberry-pi (HDP) Support | RPI | Rapsberry-pi support tickets (only for Preferred members) |
Default | RDK_JIRA_TRIAGE | By default, support type will be RDK_JIRA_TRIAGE. All normal users without RDK support credentials can create these JIRA tickets via mailing to support@rdkcentral.com. This will be filtered to appropriate category by triage team. |