google/eng-practicesArchived
Eng Practices
This project is a software engineering standards guide and technical quality manual. It provides a framework for engineering governance, focusing on maintaining code quality, peer review processes, and sustainable development across large-scale technical organizations.
The documentation establishes a code review framework that covers preparing, performing, and assigning peer reviews to ensure codebase stability. It defines standardized engineering patterns and maintainability criteria to keep diverse project repositories uniform and readable.
The guidelines encompass code quality assurance, secure repository management, and technical peer collaboration. This includes processes for evaluating software design and complexity, analyzing repository workflows for security vulnerabilities, and coordinating developer walkthroughs.
Features
- Governance Frameworks - Provides a comprehensive governance-based documentation framework to maintain uniform engineering standards.
- Software Engineering Standards - Serves as a comprehensive collection of standards for maintaining code quality, peer review, and sustainable development.
- Code Review Frameworks - Establishes a standardized framework for preparing, performing, and assigning peer reviews to ensure codebase stability.
- Code Review Practices - Establishes standardized practices and checklists for the end-to-end peer review workflow.
- Code Quality and Review - Defines systematic processes and maintainability criteria for conducting technical code reviews.
- Code Review Policies - Defines code review policies that mandate multi-party approval before merging changes into the main repository.
- Engineering Governance - Defines the organizational governance framework for consistent development patterns and security scanning requirements.
- Engineering Standards - Defines shared engineering templates and maintainability criteria as part of organizational engineering standards.
- Peer Review Workflows - Mandates standardized peer review workflows including second-person approvals and specific change formats.
- Technical Quality Criteria - Provides detailed criteria for assessing code complexity, maintainability, and design correctness.
- Code Quality and Review - Details the process for assessing software design, complexity, and documentation to ensure maintainability.
- Quality Assurance Practices - Provides structured approaches for evaluating software design and complexity as part of quality assurance.
- Security and Vulnerability Scanning - Includes procedures for scanning repository actions and workflows to identify security vulnerabilities.
- Review Preparation Standards - Standardizes change descriptions and commit sizes to accelerate the technical approval process.
- Atomic Commit Strategies - Provides a structured strategy for creating atomic commits to facilitate cleaner code reviews.
- Reviewer Selection Processes - Establishes guidelines for identifying qualified code owners to provide thorough technical feedback.
- Workflow Scanning - Establishes automated scanning for repository actions and configurations to detect security vulnerabilities.
- Repository Security Policies - Defines mechanisms for analyzing repository actions to enforce security and trust policies.
- Collaborative Peer Reviews - Provides a framework for collaborative peer reviews using synchronous validation and human walkthroughs.
- Collaborative Review Methodologies - Integrates synchronous collaboration methods like pair programming and live walkthroughs into the review process.
- Expertise-Based Reviewer Assignment - Implements a process for matching pending changes to qualified owners based on area expertise.
- Engineering Practices - Standardized guidance for performing and submitting code reviews.
