Skip to content

Create Contributing.md for new contribution Process#11

Merged
kierancoghlan merged 7 commits intordkcentral:mainfrom
AkhilaReddyK7:Documentation
May 5, 2026
Merged

Create Contributing.md for new contribution Process#11
kierancoghlan merged 7 commits intordkcentral:mainfrom
AkhilaReddyK7:Documentation

Conversation

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor

This PR adds the Community Contribution Process documentation in Markdown format for publication on GitHub.
The content is a direct conversion of the discussed document into a .md file

@kierancoghlan
Copy link
Copy Markdown
Contributor

project-community repo - that does not exist yet. I think it need to be created prior to release this document.
Issue template - is the issue template created ? It would need to be in place before release of the document
community-contribution label - does such a label exist? It would need to be in place before release of the document.

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor Author

@kierancoghlan
project-community repo - that does not exist yet. I think it need to be created prior to release this document.
Yes, created CMFSUPPORT ticket for creating a new repo under rdkcentral.

Issue template - is the issue template created ? It would need to be in place before release of the document.
Yes, I have created templates for three issue types (Bug_fix, feature, improvement) and are ready. The plan is to add the template yml files once the "project-community" repository is created.

community-contribution label - does such a label exist? It would need to be in place before release of the document.
Yes, the label is already available. I have created a CMFSUPPORT ticket previously and is available for usage now.

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor Author

@kierancoghlan

  1. As the dedicated repository is created named: "rdk-community-contributions", the document is updated to reflect it.
  2. Issue templates are ready. Please let me know if I can raise a PR for pushing the templates under "rdk-community-contributions" repo?
  3. Completed.

@kierancoghlan
Copy link
Copy Markdown
Contributor

The repo is still identified as project community in the workflow diagram - can that also be updated?

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor Author

The repo is still identified as project community in the workflow diagram - can that also be updated?

Done, updated

@kierancoghlan
Copy link
Copy Markdown
Contributor

Looks good to me

@kierancoghlan
Copy link
Copy Markdown
Contributor

Review of latest updates:

  1. Purpose:
    First line is no longer correct as that document is no longer only documenting the Feature-Based-First model
  2. Technical Rational for the Feature-Based-First model:
    This section should be moved to the Feature based workflow section
  3. Simplified Fork-Based PR workflow section:
    The Overview refers to automated builds - best to remove the word 'automated' (The proposal is that the contribution intake team runs manual builds)
  4. Workflow Diagram:
    'Merge to Default Branch’ box, update to say 'Component Owner Merges to Default Branch'
    'Contributor Updates PR' should not go back to 'Raise PR from Fork Link GitHub Issue'
  5. Step-By-Step Explanation :
    Please add the actors to each step. (Same as is done for Feature based workflow steps)
    Step 2 - ‘or once alignment is reached’ implies an issue doesn’t have to be created - only alignment is needed. I don’t think that what is meant.
  6. Summary of responsibilities section
    Remove the ‘ ‘ quotes at the end of the last bullet.

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor Author

@kierancoghlan

  1. Purpose:
    First line is no longer correct as that document is no longer only documenting the Feature-Based-First model
    Response: Corrected.
  2. Technical Rational for the Feature-Based-First model:
    This section should be moved to the Feature based workflow section
    Response: Corrected.
  3. Simplified Fork-Based PR workflow section:
    The Overview refers to automated builds - best to remove the word 'automated' (The proposal is that the contribution intake team runs manual builds)
    Response: Corrected.
  4. Workflow Diagram:
    'Merge to Default Branch’ box, update to say 'Component Owner Merges to Default Branch'
    Response: Corrected.
    'Contributor Updates PR' should not go back to 'Raise PR from Fork Link GitHub Issue'
    Response: Corrected, changed as 'Contributor Updates PR' to 'Contribution Intake Team' since we might need to re-do build/test steps after the review comments are fixed.
  5. Step-By-Step Explanation :
    Please add the actors to each step. (Same as is done for Feature based workflow steps)
    Response: Added the actors at each step.
    Step 2 - ‘or once alignment is reached’ implies an issue doesn’t have to be created - only alignment is needed. I don’t think that what is meant.
    Response: Yes, you are right, removed it.
  6. Summary of responsibilities section
    Remove the ‘ ‘ quotes at the end of the last bullet.
    Response: Corrected.

@kierancoghlan
Copy link
Copy Markdown
Contributor

Nearly there - one more change requested - please changes references to 'default branch' to 'development branch'
Specifically

  1. In the workflow fourth box change "Raise PR from Fork Link GitHub Issue" to "Raise PR from Fork to the development branch Link GitHub Issue"
  2. In the workflow nineth box change "Component Owner merges to default branch" to "Component Owner merges to development branch"
  3. Update Step 3 Change "A Pull Request (PR) is raised from the forked repository to the default branch of the upstream code repository." to "A Pull Request (PR) is raised from the forked repository to the development branch of the upstream code repository.
  4. Update Step 9 Change "The PR is merged into the default branch" to "The PR is merged into the development branch"

@AkhilaReddyK7
Copy link
Copy Markdown
Contributor Author

@kierancoghlan
Corrected the branch instances. Please review and merge.

@kierancoghlan kierancoghlan merged commit 90a5e88 into rdkcentral:main May 5, 2026
3 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators May 5, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants