elastic/elasticsearch

full scan as JSON

• Extract for clarityExtract complex or reused logic into focused, well-named methods with single responsibilities. This improves code readability, testabilit...

  elastic/elasticsearch Code Style Java data-systems 2025-07-02

  copy raw open
• Name reflects meaningChoose names that clearly communicate the intent, behavior, and semantics of code elements. Names should be accurate, consistent, and fol...

  elastic/elasticsearch Naming Conventions Java data-systems 2025-07-02

  copy raw open
• Optimize before implementingBefore implementing algorithms, evaluate their efficiency implications, especially for operations that may be executed frequently or with...

  elastic/elasticsearch Algorithms Java data-systems 2025-06-30

  copy raw open
• Measure before optimizing performanceBefore implementing performance optimizations, measure and validate the impact through benchmarks. This applies especially to: 1. Changes...

  elastic/elasticsearch Performance Optimization Java data-systems 2025-07-01

  copy raw open
• Use configuration access methodsWhen accessing configuration settings, always use the appropriate type-safe accessor methods provided by the configuration framework rath...

  elastic/elasticsearch Configurations Java data-systems 2025-07-01

  copy raw open
• Robust test assertionsUse precise, informative assertions in tests to provide clear feedback when tests fail and verify the correct behavior rather than implem...

  elastic/elasticsearch Testing Java data-systems 2025-06-30

  copy raw open
• Prefer callbacks over blockingAlways structure concurrent code to use asynchronous callbacks instead of blocking operations. Blocking calls like CountDownLatch, Thread...

  elastic/elasticsearch Concurrency Java data-systems 2025-06-29

  copy raw open
• Prevent redundant operationsIn distributed database systems, prevent redundant operations that can overload cluster resources. When implementing update operations th...

  elastic/elasticsearch Database Java data-systems 2025-07-02

  copy raw open
• Clarity over uncertaintyTechnical documentation should use precise language that clearly differentiates between product behavior and user configuration options. ...

  elastic/elasticsearch Documentation Markdown data-systems 2025-07-02

  copy raw open
• Configure type serializationWhen working with databases that exchange data with other systems, ensure proper serialization and deserialization of data types like UUI...

  elastic/elasticsearch Database Markdown data-systems 2025-07-02

  copy raw open
• Defensive null handlingAlways handle null references and values defensively to prevent NullPointerExceptions and unexpected behavior. Follow these practices: 1....

  elastic/elasticsearch Null Handling Java data-systems 2025-06-30

  copy raw open
• Parallel branch traceabilityWhen implementing algorithms with parallel processing branches, ensure proper traceability and data consistency across all branches to fa...

  elastic/elasticsearch Algorithms Markdown data-systems 2025-06-30

  copy raw open
• Exceptions for critical errorsUse exceptions rather than assertions for handling critical error conditions that need to be caught in production. Assertions should only...

  elastic/elasticsearch Error Handling Java data-systems 2025-06-27

  copy raw open
• Design for evolutionWhen designing APIs, prioritize flexibility and independent evolution of components. Avoid tightly coupling related services or wrapping ...

  elastic/elasticsearch API Java data-systems 2025-07-02

  copy raw open
• Stage intensive operations carefullyWhen implementing operations that consume significant system resources (CPU, memory, I/O), introduce changes gradually while monitoring p...

  elastic/elasticsearch Performance Optimization Markdown data-systems 2025-06-30

  copy raw open
• Scope and document configurationsWhen designing and implementing configuration options, carefully consider two key aspects: 1. **Choose appropriate configuration scope**:...

  elastic/elasticsearch Configurations Markdown data-systems 2025-06-27

  copy raw open
• Specify explicit REST formatsAlways specify explicit request formats in REST API tests rather than relying on default behaviors. This includes: 1. Set appropriate Con...

  elastic/elasticsearch API Yaml data-systems 2025-07-02

  copy raw open
• Avoid flaky testsDesign tests to be deterministic and reliable across different environments. Tests that occasionally fail due to timing, race conditions,...

  elastic/elasticsearch Testing Yaml data-systems 2025-06-13

  copy raw open
• Use current configuration patternsAlways use the current recommended configuration patterns for your project, avoiding deprecated approaches. When configuring tests, featu...

  elastic/elasticsearch Configurations Yaml data-systems 2025-06-13

  copy raw open
• Document performance tradeoffsAlways explicitly document the performance implications of API parameters, limit changes, and features that could significantly impact re...

  elastic/elasticsearch Performance Optimization Other data-systems 2024-06-24

  copy raw open
• Complete API parameter documentationAPI endpoints must include comprehensive documentation for all parameters. For each parameter, clearly specify: 1. Whether it''s required...

  elastic/elasticsearch API Other data-systems 2024-04-23

  copy raw open
• Document security requirements explicitlyAlways document security-related configurations, permissions, and behaviors explicitly and comprehensively. When documenting security fea...

  elastic/elasticsearch Security Other data-systems 2023-05-03

  copy raw open
• Enforce least privilegeAlways assign the minimum permissions necessary for functionality when implementing role-based access controls. This fundamental security...

  elastic/elasticsearch Security Java data-systems 2025-07-01

  copy raw open