reviewing-guide

Create or update REVIEWING.md files documenting code review processes for CNCF projects.

2|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/castrojo/cncf-skills --skill reviewing-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reviewing-guide
Source: https://github.com/castrojo/cncf-skills/tree/main/skills/reviewing-guide
Command: npx skills add https://github.com/castrojo/cncf-skills --skill reviewing-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill establishes clear, documented guidelines for conducting code reviews, ensuring consistency and improving the quality of feedback within a project.

Core Features & Use Cases

  • Define Reviewer Roles: Clarify who is authorized to review code and distinguish between reviewer and maintainer roles.
  • Document Review Process: Outline the steps involved in a review, including required approvals and merge policies.
  • Standardize Checklist: Provide a consistent set of checks for reviewers, including code correctness, testing, documentation, and security.
  • Use Case: A growing open-source project with diverse contributors can use this Skill to create a REVIEWING.md file that guides new and existing contributors on the project's specific review norms and expectations.

Quick Start

Create or update the REVIEWING.md file with project-specific reviewer roles, values, process, and a review checklist.

Frequently Asked Questions about reviewing-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a standardized code review process for an open source project?

To create a standardized code review process, you generate a REVIEWING.md file that documents reviewer roles, values, required approvals, and a mandatory checklist for maintainers and contributors.

What should be included in a contributing guide to ensure consistent code reviews?

A contributing guide for consistent code reviews should include defined reviewer and maintainer roles, documented process steps, merge policies, and a checklist covering correctness, testing, documentation, and security.

How do I document code review expectations for CNCF projects?

Documenting code review expectations for CNCF projects involves creating a REVIEWING.md file that defines reviewer roles, outlines the review process, and provides a mandatory checklist to address review behavior inconsistencies.

Why do we need a REVIEWING.md file for project maintainers?

You need a REVIEWING.md file to establish clear, documented guidelines for conducting code reviews, which ensures consistency and improves the quality of feedback within a growing project with diverse contributors.

Can I distinguish between reviewer and maintainer roles in a code review process?

Yes, you can distinguish between reviewer and maintainer roles by defining their specific authorities and responsibilities within the REVIEWING.md file to clarify who is authorized to review and approve code.

What is the best way to standardize a code review checklist for maintainers?

The best way to standardize a code review checklist is to document a consistent set of checks in REVIEWING.md, covering code correctness, testing, documentation, and security for all project contributors.