kubeflow/kubeflow

The scan found no tool the scanner recognises.

full scan as JSON

• Go export naming conventionsIn Go, the first letter of an identifier (function, variable, struct field, etc.) determines its visibility outside the package: 1. **Upp...

  kubeflow/kubeflow Naming Conventions Go ml-systems 2023-10-26

  copy raw open
• Precise workflow triggersConfigure CI/CD workflows to trigger precisely based on relevant file path changes. This minimizes unnecessary builds and tests while ens...

  kubeflow/kubeflow CI/CD Yaml ml-systems 2022-12-20

  copy raw open
• Simplify code structureStrive to simplify code structure by eliminating unnecessary complexity. This includes: 1. **Move conditions higher in the code** when ap...

  kubeflow/kubeflow Code Style Go ml-systems 2022-08-29

  copy raw open
• Centralize configuration valuesStore all configuration values in dedicated configuration files rather than hardcoding them throughout the application. This makes the co...

  kubeflow/kubeflow Configurations TypeScript ml-systems 2024-09-06

  copy raw open
• Structured documentation with examplesCreate comprehensive documentation with clear structure and practical examples. Documentation should include: 1. **Standard documentation...

  kubeflow/kubeflow Documentation Markdown ml-systems 2024-09-06

  copy raw open
• Environment variable managementManage environment variables in Docker configurations with appropriate scope, placement, and documentation: 1. **Set environment variable...

  kubeflow/kubeflow Configurations Dockerfile ml-systems 2024-08-23

  copy raw open
• Standardize makefile patternsMaintain consistent Makefile patterns across all components to improve build reliability and developer experience in CI/CD pipelines. Key...

  kubeflow/kubeflow CI/CD Other ml-systems 2023-05-05

  copy raw open
• Use modern JavaScript idiomsFavor modern JavaScript syntax and clean code practices to improve readability and maintainability. This includes: 1. **Use template lite...

  kubeflow/kubeflow Code Style JavaScript ml-systems 2021-05-31

  copy raw open
• Centralize configuration constantsStore configuration constants, defaults, and environment variable mappings in dedicated configuration files rather than duplicating them ...

  kubeflow/kubeflow Configurations Python ml-systems 2024-09-02

  copy raw open
• Standardize network toolsWhen performing network operations in build scripts or containers, prefer `curl` over `wget` for HTTP requests to standardize dependencie...

  kubeflow/kubeflow Networking Dockerfile ml-systems 2024-08-21

  copy raw open
• Externalize configuration parametersCreate configurations that can be easily managed outside your application code. Design configuration parameters to be externalized throug...

  kubeflow/kubeflow Configurations Markdown ml-systems 2023-10-26

  copy raw open
• Pin version dependenciesExplicitly pin version dependencies in configuration files to ensure reproducible builds and prevent breaking changes. When dealing with ...

  kubeflow/kubeflow Configurations Other ml-systems 2022-07-14

  copy raw open
• Load configurations efficientlyWhen designing components that require configuration, follow these practices to enhance performance, maintainability, and usability: 1. *...

  kubeflow/kubeflow Configurations Go ml-systems 2021-03-30

  copy raw open
• Follow API conventionsWhen designing APIs, adhere to established API conventions, particularly Kubernetes API conventions when working within the Kubernetes ec...

  kubeflow/kubeflow API Go ml-systems 2021-03-12

  copy raw open
• Prioritize readability over brevityWhen writing code, favor readability and maintainability over clever or compact solutions. Break down complex logic into smaller, well-na...

  kubeflow/kubeflow Code Style Python ml-systems 2020-09-24

  copy raw open
• Document code thoroughlyAlways include appropriate documentation in your code to improve readability, maintainability, and usability: 1. **Document all public AP...

  kubeflow/kubeflow Documentation Go ml-systems 2020-09-21

  copy raw open
• Contextualize and classify errorsAlways provide meaningful context when handling errors, and classify them appropriately based on their source. This improves debugging, h...

  kubeflow/kubeflow Error Handling Go ml-systems 2020-01-21

  copy raw open
• Document with precisionWrite informative, consistent, and precise code comments throughout your codebase. When documenting code: 1. **Be specific with reference...

  kubeflow/kubeflow Documentation Dockerfile ml-systems 2024-08-17

  copy raw open
• Environment-aware configuration designDesign configurations that work consistently across different environments without requiring environment-specific modifications. Configur...

  kubeflow/kubeflow Configurations Yaml ml-systems 2023-09-06

  copy raw open
• Structured OWNERS filesOWNERS files must follow project documentation standards to properly reflect component ownership and maintainership. When creating or upd...

  kubeflow/kubeflow Documentation Other ml-systems 2023-06-03

  copy raw open
• Use appropriate log levelsAlways match logging levels to the message's purpose and severity. Use log.Info for general information, log.Warn for warnings, and log.E...

  kubeflow/kubeflow Logging Go ml-systems 2023-04-13

  copy raw open
• Use snake_case in PythonFollow Python's PEP 8 naming convention by using snake_case for variables, functions, and methods rather than camelCase or other styles. ...

  kubeflow/kubeflow Naming Conventions Python ml-systems 2023-03-22

  copy raw open
• Normalize URL pathsWhen handling URLs in web applications, consistently normalize path formats to prevent routing and service communication issues. This is ...

  kubeflow/kubeflow Networking TypeScript ml-systems 2023-01-30

  copy raw open
• Specific network access documentationWhen documenting network access methods or service connections, always provide specific commands with explicit ports and namespaces rathe...

  kubeflow/kubeflow Networking Markdown ml-systems 2022-11-23

  copy raw open
• Use table-driven testsIn Go, prefer table-driven tests over multiple separate test functions. Table tests allow for concise testing of multiple scenarios, impr...

  kubeflow/kubeflow Testing Go ml-systems 2022-08-30

  copy raw open
• Check before useAlways validate that objects, maps, and other reference types are non-nil before attempting to use them. Use early nil checks with clear ...

  kubeflow/kubeflow Null Handling Go ml-systems 2022-08-29

  copy raw open
• Manage configuration changesCarefully manage configuration file changes to ensure consistency and minimize unintended impacts across your project. When modifying con...

  kubeflow/kubeflow Configurations Json ml-systems 2021-12-22

  copy raw open
• Mark UI text i18nAll user-facing text in HTML templates should be marked for internationalization using the i18n directive. This includes labels, placehol...

  kubeflow/kubeflow Documentation Html ml-systems 2021-08-12

  copy raw open
• Standardize build configurationsAll components should use consistent build configurations and patterns in their CI/CD setup. This includes standardizing Makefile variabl...

  kubeflow/kubeflow CI/CD Markdown ml-systems 2021-03-17

  copy raw open
• Enforce least privilegeConfigure all systems with the minimum permissions required to function. For Kubernetes deployments, use security contexts that prevent p...

  kubeflow/kubeflow Security Yaml ml-systems 2025-04-08

  copy raw open
• Structure for navigationDocumentation should be structured to optimize user navigation and information discovery. When organizing documentation elements: 1. Grou...

  kubeflow/kubeflow Documentation Yaml ml-systems 2024-09-09

  copy raw open
• Centralize dependency configurationsWhen adding or updating package dependencies, place them in centralized configuration files rather than duplicating them across multiple ...

  kubeflow/kubeflow Configurations Txt ml-systems 2023-10-16

  copy raw open
• Consistent descriptive namingMaintain consistency in naming patterns across related resources while ensuring names accurately reflect their purpose. When naming compo...

  kubeflow/kubeflow Naming Conventions Yaml ml-systems 2023-06-04

  copy raw open
• Document migration pathsWhen implementing version changes or migrations, provide comprehensive documentation and tools to support users through the transition pr...

  kubeflow/kubeflow Migrations Markdown ml-systems 2023-05-29

  copy raw open
• Component-agnostic styling principlesCreate reusable components with styles that don't make assumptions about parent contexts or affect their positioning in different applica...

  kubeflow/kubeflow Code Style Css ml-systems 2023-03-30

  copy raw open
• Private variable naming conventionUse the 'prv' prefix for private class members and ensure they're explicitly declared with the 'private' access modifier. This maintains ...

  kubeflow/kubeflow Naming Conventions TypeScript ml-systems 2023-03-24

  copy raw open
• Match algorithms to purposeSelect algorithmic constructs and control structures that are appropriate for the specific task. Common issues include: 1. Using loops wh...

  kubeflow/kubeflow Algorithms Python ml-systems 2023-03-23

  copy raw open
• Type-appropriate default valuesInitialize variables with type-appropriate default values to prevent type errors and null reference exceptions during operations. When a ...

  kubeflow/kubeflow Null Handling Python ml-systems 2023-03-23

  copy raw open
• API structure balanceMaintain a clear separation between resource-specific API handlers and common utilities. Resource-specific handlers should remain in thei...

  kubeflow/kubeflow API Python ml-systems 2023-03-15

  copy raw open
• Reduce nesting depthImprove code readability by reducing nesting depth with early returns and functional approaches. Use early returns to handle edge cases f...

  kubeflow/kubeflow Code Style TypeScript ml-systems 2023-03-14

  copy raw open
• Safe URL operationsWhen handling URLs for API interactions and navigation, use precise methods for both comparison and construction to avoid subtle bugs: 1....

  kubeflow/kubeflow API TypeScript ml-systems 2023-02-24

  copy raw open
• Use enums for stateWhen handling nullable or undefined states, use enumerations instead of primitive types like boolean or null/undefined. Enums provide mor...

  kubeflow/kubeflow Null Handling TypeScript ml-systems 2023-01-31

  copy raw open
• Standardize style scriptsMaintain consistent code style enforcement scripts across all projects by standardizing linting and formatting configurations in package....

  kubeflow/kubeflow Code Style Json ml-systems 2022-12-15

  copy raw open
• Automate style enforcementConfigure your development environment to automatically enforce code style standards rather than relying on manual checks during code rev...

  kubeflow/kubeflow Code Style Yaml ml-systems 2022-12-05

  copy raw open
• Descriptive consistent namingUse descriptive and consistent names throughout the codebase. Prefer full, meaningful names over acronyms or abbreviations to improve rea...

  kubeflow/kubeflow Naming Conventions Other ml-systems 2022-11-30

  copy raw open
• Optimize container build configurationsConfigure containerized application builds to be efficient and flexible by avoiding hardcoded architecture decisions and using appropriat...

  kubeflow/kubeflow CI/CD Dockerfile ml-systems 2022-11-23

  copy raw open
• Validate model optimizationWhen implementing AI model optimization techniques such as early stopping algorithms or hyperparameter tuning, include proper validation ...

  kubeflow/kubeflow AI Markdown ml-systems 2022-11-17

  copy raw open
• Prefer external configurationDesign applications to use external configuration sources rather than hardcoding values directly in source code. This allows for configur...

  kubeflow/kubeflow Configurations JavaScript ml-systems 2022-10-17

  copy raw open
• Validate inputs explicitlyAlways validate input parameters and respond with appropriate HTTP status codes when invalid values are detected, even when inputs appear...

  kubeflow/kubeflow Error Handling Python ml-systems 2021-08-13

  copy raw open
• Document networking annotationsWhen using Istio or other networking-related annotations in configuration files, always include detailed comments explaining their purpos...

  kubeflow/kubeflow Networking Yaml ml-systems 2021-04-13

  copy raw open
• Use CSS classes properlyAvoid inline styles and `!important` declarations in your HTML templates. Instead, define and use CSS classes that encapsulate styling ne...

  kubeflow/kubeflow Code Style Html ml-systems 2021-03-16

  copy raw open
• Unique workflow step namesWhen defining CI/CD workflows, always ensure task/step names are unique to prevent execution failures. Workflow engines like Argo will re...

  kubeflow/kubeflow CI/CD Python ml-systems 2021-03-12

  copy raw open
• Consistent separator conventionsUse appropriate separators in compound identifiers to improve readability and ensure naming consistency across the codebase. Specifically...

  kubeflow/kubeflow Naming Conventions Markdown ml-systems 2021-01-04

  copy raw open
• Stable configuration managementAlways ensure configuration values are managed consistently and sourced\ \ from stable locations. \n\n1. Use defined constants instead of...

  kubeflow/kubeflow Configurations TSX ml-systems 2019-11-25

  copy raw open
• Isolate test casesCreate separate test functions for distinct functionality to improve test clarity and make failure points more obvious. When writing test...

  kubeflow/kubeflow Testing Python ml-systems 2019-10-18

  copy raw open
• Standardize metrics collectionUse the appropriate metric types for the data being collected and consider\ \ centralizing monitoring code to ensure consistency across c...

  kubeflow/kubeflow Observability Go ml-systems

  copy raw open
• Harden container securityWhen building container images, ensure they''re compatible with restricted Kubernetes security contexts. Use numeric UIDs instead of symb...

  kubeflow/kubeflow Security Dockerfile ml-systems 2024-06-30

  copy raw open
• Private vulnerability reportingNever expose security vulnerabilities in public issue trackers. Security issues require confidential handling to prevent exploitation bef...

  kubeflow/kubeflow Security Markdown ml-systems 2023-05-16

  copy raw open
• Control header modificationWhen allowing user-configurable HTTP headers in your application, implement strict validation to prevent security bypasses. Users should ...

  kubeflow/kubeflow Security Go ml-systems 2021-03-11

  copy raw open
• Configurable security with defaultsMake security features configurable through environment variables or configuration files, but always implement secure defaults. This allo...

  kubeflow/kubeflow Security Python ml-systems 2020-12-23

  copy raw open
• Enforce HTTPS protocolAlways validate that URLs use the HTTPS protocol in both implementation code and validation error messages. Even if your application migh...

  kubeflow/kubeflow Security TypeScript ml-systems 2020-02-20

  copy raw open
• Prevent XSS vulnerabilitiesNever directly concatenate untrusted data (like user inputs or API responses) into HTML strings, as this creates cross-site scripting (XS...

  kubeflow/kubeflow Security JavaScript ml-systems 2019-02-11

  copy raw open