Contributing guide update and Community guide

COMMUNITY.md

@@ -0,0 +1,107 @@
+# Nephio Project Community membership
+
+This document describes the responsibilities and contributor roles in Nephio Project. 
+
+| Role | Responsibilities | Requirements | Defined by |
+| -----| ---------------- | ------------ | -------|
+| New contributor |  - | Submits the Pull Request on GitHub | Anyone is welcome to participate |
+| Member | Active contributor | Sponsored by one reviewer and has several contributions to the project | Nephio GitHub org member|
+| Reviewer | Review contributions from other members | History of review and authorship in the project | [OWNERS] file reviewer entry |
+| Approver | Contributions acceptance approval| Highly experienced active reviewer and contributor to the project | [OWNERS] file approver entry|
+
+## New contributor
+
+Anyone is welcome to contribute to Nephio project. Existing members should make a point of being helpful 
+for new contributors in any way possible (PR workflow, finding relevant documentation, guiding with coding style etc.)
+Remember we were all '[new contributors]' once.
+
+## Member
+
+Members are active contributors in the community. Members might have PRs and GitHub issues assigned to them and are added to GitHub team(s).
+Prow's presubmit tests are automatically run for their PRs as well as GitHub Actions (where applicable). 
+Members are welcome to remain continuously active contributors to the community.
+
+### Requirements
+
+- Ensure affiliation is up to date in [openprofile.dev]. 
+- Have made **several contributions** to the project or community, enough to
+  demonstrate an **ongoing and possible long-term commitment** to the project like:
+    - Authoring or reviewing PRs on GitHub, with at least one **merged** PR.
+    - Filing or commenting on issues on GitHub
+    - Contributing to SIG, subproject, or community discussions (meetings,
+      Slack, mailing list)
+- Have read the [contributor guide]
+- Sponsored by one reviewer
+- **Open an issue [Membership request] against the 'nephio' repo**
+   - Ensure your sponsor is @mentioned on the issue
+   - Provide information described above that is representative of your work on the project
+- Have your sponsoring reviewer reply confirmation of sponsorship
+- Once your sponsors have responded, your request will be reviewed by the [GitHub Admin team].
+
+### Responsibilities and privileges
+
+- Responsive to issues and PRs assigned to them
+- Responsive to mentions of SIG teams they are members of
+- Active owner of code they have contributed
+  - Code is well tested
+  - Tests consistently pass
+  - Addresses bugs or issues discovered after code is accepted
+- Members can do `/lgtm` on all PRs.
+- They can be assigned to issues and PRs, and people can ask members for reviews with a `/cc @username`.
+- Tests will be run against their PRs automatically. No `/ok-to-test` needed or approving GitHub Actions run.
+- Members can do `/ok-to-test` for PRs that have a `needs-ok-to-test` label, and close PRs.
+
+## Reviewer
+
+Reviewers check code for quality and correctness. They are knowledgeable about both the project (or parts of it) 
+and software engineering principles.
+
+### Requirements
+
+The following apply to the part of codebase for which one would be a reviewer in
+an [OWNERS] file.
+
+- Member for at least 2 months
+- Primary reviewer for at least 5 PRs to the codebase
+- Knowledgeable about the project and codebase
+- Sponsored by an approver
+  - With no objections from other approvers
+  - Done through PR to update the OWNERS file: either self-nominate or any other member of the Nephio Project
+
+### Responsibilities and privileges
+
+- Tests are automatically run for their PRs
+- Responsible for project quality control via code reviews
+- Expected to be responsive to review requests
+- Assigned PRs to review related to subproject of expertise
+- Assigned test bugs related to subproject of expertise
+- Granted "read access" to Nephio Project repo(s)
+
+## Approver
+
+Code approvers are able to both review and approve code contributions (by setting labels `approved` and `lgtm`). 
+While code review is focused on code quality and correctness, approval is focused on broad acceptance of a contribution including: backward and/or forward
+compatibility, adhering to API, performance and correctness issues, interactions with other parts of project and so on.
+
+### Requirements
+
+- Reviewer of the codebase for at least 2 months
+- Primary reviewer for at least 10 PRs to the codebase
+- Nominated by a project owner or other approver
+  - With no objections from other project owners or approvers
+  - Done through PR to update the OWNERS file
+
+### Responsibilities and privileges
+
+- Demonstrate sound technical judgement
+- Responsible for project quality control via code reviews
+  - Focus on holistic acceptance of contribution such as dependencies with other features, backwards and/or forwards
+    compatibility, API and flag definitions, etc
+- Expected to be responsive to review requests
+- Mentor contributors and reviewers
+- May approve code contributions for acceptance
+
+
+[new contributors]: /CONTRIBUTING.md
+[OWNERS]: https://www.kubernetes.dev/docs/guide/owners/
+[openprofile.dev]: https://openprofile.dev/edit/profile

CONTRIBUTING.md

@@ -10,6 +10,8 @@ We welcome all contributions, suggestions, and feedback, so please do not hesita
     - [3. Submit Pull Requests](#3-submit-pull-requests)
       - [How to Create a PR](#how-to-create-a-pr)
       - [Developer Certificate of Origin (DCO) Sign off](#developer-certificate-of-origin-dco-sign-off)
+      - [Code Review of the Pull Request](#code-review-of-the-pull-request)
+      - [Possible problems and quirks](#possible-problems-and-quirks)
 
 ## Engage with us
 
@@ -135,3 +137,42 @@ This can easily be done with the `-s` command line option to append this automat
 ```sh
 git commit -s -m 'This is my commit message'
 ```
+#### Code Review of the Pull Request
+
+In Nephio Project uses [Prow](https://docs.prow.k8s.io/) to among many other tasks test and manage the Pull Requests. Prow also allows to interact with PR trough ['slash' commands](https://prow.nephio.io/command-help)
+
+##### The Code Review Process
+The **author** submits a PR
+- Step 0: [Prow bot](https://github.com/apps/nephio-prow) assigns reviewers and approvers for the PR based on [OWNERS files](https://www.kubernetes.dev/docs/guide/owners/) please note that single repository can have multiple OWNERS files, bot will choose reviewers and approvers from file nearest to changed code 
+- Step 1: Prow tests the PR
+If the author is not (yet) a member of Nephio GitHub organization Prow will add label 'needs-ok-to-test' which will prevent Prow from running tests on it. This is a security measure as many tests allow to execute arbitrary code, create objects in infrastructure and so on. To allow the tests to run any member of organization can use command
+/ok-to-test in comment, then tests will run. Status of their execution will be visible on PR page itself or if one wants to see logs, previous runs etc those are available on [Prow's Dashboard](https://prow.nephio.io/)
+Definions of those tests are either in local [inrepoconfig](https://docs.prow.k8s.io/docs/inrepoconfig/) file .prow.yaml or in [central Prow configuration](https://github.com/nephio-project/test-infra/tree/main/prow/config)
+- Step 2: Review of the PR
+Reviewers check the code quality, correctness, software engineering best practices, coding style and so on.
+Anyone in the organization can act as a reviewer with the exception of the individual who opened the PR
+If PR content looks good to them, a reviewer types /lgtm (**looks** **good** **to** **me**) in the PR comment or review; Prow bot will then apply 'lgtm' label to the PR, this can be canceled by removing label or using '/lgtm cancel' command
+- Step 3: Approval of the PR
+Only people listed in the relevant OWNERS file in section 'approvers', either directly or through an alias, can act as approvers, including the individual who opened the PR.
+Approvers check for acceptance criteria, compatibility with other features, forwards/backwards compatibility, API definitions and so on.
+If the code changes gets their approval, an approver types /approve in a PR comment or review; this as well can be canceled with '/approve cancel' command
+Prow bot applies an approved label
+- Step 4: Automation merges the PR
+If all of the following conditions are met:
+  - All required labels are present (lgtm, approved)
+  - No blocking labels are present (do-not-merge/hold, needs-rebase)
+  - There are no presubmit prow jobs failing 
+  - Then the PR will automatically be merged
+
+##### Possible problems and quirks
+
+- Approval and lgtm process
+  - Technically anyone who is a member of the Nephio GitHub organization can /lgtm a PR which can be both good (reviews from non-members are encouraged as a way of demonstrating experience and intent to become a member or reviewer) and bad (/lgtm’s from members may be a sign that our OWNERS files are too small, or that the existing reviewers are too busy). Note to approvers (who can do both approve and lgtm) - if possible please leave lgtm to other in the spirit of having at least two sets of eyes on every change.
+  - Reviewers, and approvers are unresponsive
+Please do not rely on GitHub notifications sent to approvers/reviewers or mentions like “pinging @the_rewiever for approval” - those are really hard to filter and reviewers/approvers are very busy people. If your PR doesn't get enough attention consider asking for the review in respective Slack channels.
+- Prow things
+  - If the presubmit job fails there's a message posted by Prow bot that explains steps how to re-run it, for example with command /test my_awesome_presubmit_test
+  - Sometimes it takes a while to merge the PR after it was approved, PR queue can be observed on [Prow's Tide status dashboard](https://prow.nephio.io/tide)
+  - If the PR gets final step like approve or lgtm done after 12 hours pass since presubmit tests were run they are getting re-triggered
+- GitHub things
+  - EasyCLA sometimes non-properly check the status, it can be re-triggered with /easycla command or it often sorts out when you close and re-open the PR