istio/istio

full scan as JSON

• Use descriptive namesNames should accurately reflect their actual functionality and behavior. Avoid misleading or vague identifiers that don't match what the ...

  istio/istio Naming Conventions Go orchestration 2025-08-18

  copy raw open
• Add explanatory commentsCode should include explanatory comments that help future maintainers understand complex logic, design decisions, field semantics, and no...

  istio/istio Documentation Go orchestration 2025-07-10

  copy raw open
• Simplify code structurePrioritize code simplicity and readability by leveraging standard library functions, improving control flow patterns, and eliminating unn...

  istio/istio Code Style Go orchestration 2025-07-08

  copy raw open
• Return errors explicitlyFunctions should return errors explicitly to callers rather than terminating the program, hiding errors in boolean returns, or using impl...

  istio/istio Error Handling Go orchestration 2025-08-19

  copy raw open
• Avoid expensive operationsIdentify and eliminate computationally expensive operations in frequently executed code paths. Common expensive operations include repeat...

  istio/istio Performance Optimization Go orchestration 2025-08-14

  copy raw open
• prevent race conditionsAlways protect shared state access and ensure proper synchronization in concurrent operations to prevent race conditions. Key areas to re...

  istio/istio Concurrency Go orchestration 2025-08-01

  copy raw open
• Feature flag lifecycle managementEstablish clear guidelines for feature flag creation, default values, and removal strategy based on risk assessment and user impact. **Wh...

  istio/istio Configurations Go orchestration 2025-03-28

  copy raw open
• API compatibility preservationWhen evolving APIs, prioritize backward compatibility and avoid changing the semantics of existing fields. Instead of overloading existin...

  istio/istio API Go orchestration 2025-08-26

  copy raw open
• network configuration consistencyEnsure network-related configurations remain consistent across different components and avoid unintended overwrites that could break conn...

  istio/istio Networking Go orchestration 2025-08-14

  copy raw open
• Conservative networking defaultsWhen configuring networking components, prefer stable and permissive defaults over restrictive or experimental configurations that may no...

  istio/istio Networking Yaml orchestration 2025-07-21

  copy raw open
• Document observability rationaleWhen introducing, modifying, or removing observability features (tracing, metrics, monitoring configurations), always include clear docum...

  istio/istio Observability Yaml orchestration 2025-03-27

  copy raw open
• telemetry consistency standardsEnsure telemetry attribute population logic is consistent across all components and follows established standards. When implementing tele...

  istio/istio Observability Go orchestration 2022-12-16

  copy raw open
• API version compatibility firstWhen selecting API versions, prioritize compatibility over using the latest available version. Choose older, stable API versions when the...

  istio/istio API Yaml orchestration 2022-11-22

  copy raw open
• maintain consistent naming patternsEnsure naming consistency across related components and throughout the codebase to prevent developer confusion and maintenance issues. Wh...

  istio/istio Naming Conventions Yaml orchestration 2025-08-05

  copy raw open
• avoid timing dependenciesEliminate timing dependencies in tests by using proper retry mechanisms and assertions instead of sleep statements. Sleep-based waits mak...

  istio/istio Testing Go orchestration 2025-08-01

  copy raw open
• avoid repeated expensive operationsAvoid performing expensive computational operations repeatedly when the same result can be achieved through better algorithm design or da...

  istio/istio Algorithms Go orchestration 2025-07-09

  copy raw open
• Early nil checksAdd nil and empty checks at the beginning of functions to prevent downstream issues and avoid unnecessary processing. This pattern improv...

  istio/istio Null Handling Go orchestration 2025-05-30

  copy raw open
• Configuration documentation standardsEnsure all user-configurable options are properly documented and discoverable, while keeping configuration files clean and focused. Confi...

  istio/istio Configurations Yaml orchestration 2024-08-06

  copy raw open
• consistent log formattingMaintain consistent formatting conventions across log messages to improve code readability and debugging effectiveness. Use proper format...

  istio/istio Logging Go orchestration 2024-03-11

  copy raw open
• leverage kernel network structuresWhen implementing eBPF networking programs, prefer using kernel-native data structures and BPF helpers over maintaining custom eBPF maps ...

  istio/istio Networking C orchestration 2023-02-17

  copy raw open
• validate access scopeWhen implementing security features that involve access control, authentication, or authorization, carefully validate that the changes do...

  istio/istio Security Go orchestration 2025-05-22

  copy raw open
• Security behavior clarityWhen documenting or describing security-related changes, especially bug fixes and behavioral modifications, ensure clear and explicit com...

  istio/istio Security Yaml orchestration 2025-03-28

  copy raw open
• Flexible configuration defaultsConfiguration values should provide sensible defaults while remaining adaptable to different environments and deployment contexts. Use co...

  istio/istio Configurations Other orchestration 2024-08-06

  copy raw open
• verify logging configuration functionalityEnsure that logging configuration options actually perform the behavior their names suggest and provide real value. Before implementing o...

  istio/istio Logging Other orchestration 2023-12-05

  copy raw open
• Document observability clearlyEnsure observability documentation is clear, accessible, and grammatically correct. This includes defining technical acronyms and ensurin...

  istio/istio Observability Markdown orchestration 2023-03-21

  copy raw open
• optimize hot path performanceIdentify and eliminate expensive operations in frequently executed code paths, particularly in packet processing and network handling con...

  istio/istio Performance Optimization C orchestration 2022-12-09

  copy raw open
• Document security behavior referencesWhen implementing security-related functionality such as certificate parsing, cryptographic validation, or authentication mechanisms, alw...

  istio/istio Security Other orchestration 2025-07-25

  copy raw open
• audit license dependenciesAlways verify the licensing compatibility of all dependencies, especially in security-critical networking code. GPL and other restrictive...

  istio/istio Security C orchestration 2023-01-17

  copy raw open