open-telemetry/opentelemetry-python

10 other commands the scanner could not classify

Commands from CI steps and task runners that look like checks but match no known tool. Some are checks, some are not.

• markdown-link-check --verbose --config .github/workflows/check_links_config.json ${changed_files[@]}
• markdown-link-check --verbose --config .github/workflows/check_links_config.json /tmp/new_links.md
• pre-commit hook rstcheck
• python {toxinidir}/scripts/check_license_header.py
• python {toxinidir}/scripts/griffe_check.py
• python {toxinidir}/scripts/public_symbols_checker.py
• sh -c "cd tests
• sh -c "find {toxinidir} -name \*.sh
• type one of added, changed, deprecated, removed, fixed)")
• xargs shellcheck --severity=warning"

full scan as JSON

• Future-proof API designDesign APIs that can evolve without breaking existing code. Use keyword-only arguments (with `*,`) for optional parameters to make API ex...

  open-telemetry/opentelemetry-python API Python observability 2025-06-05

  copy raw open
• Optimize code location scopePlace code in the most specific and appropriate location to improve findability and maintainability. Follow these principles: 1. Avoid ge...

  open-telemetry/opentelemetry-python Code Style Python observability 2025-01-20

  copy raw open
• Write purposeful commentsComments should explain "why" and "how" rather than restating what is already obvious from the code. Focus on providing additional contex...

  open-telemetry/opentelemetry-python Documentation Python observability 2025-05-12

  copy raw open
• Sanitize observability data exportsWhen exporting observability data (metrics, traces, logs) to external systems, properly sanitize all data fields to ensure compatibility ...

  open-telemetry/opentelemetry-python Observability Python observability 2024-05-23

  copy raw open
• Configuration source precedenceDefine and document a clear precedence order when configurations come from multiple sources (code parameters, environment variables, defa...

  open-telemetry/opentelemetry-python Configurations Python observability 2025-07-04

  copy raw open
• Handle exceptions appropriatelyWhen implementing error handling logic, be deliberate about which exception types you catch and where you handle them. 1. **Catch `Except...

  open-telemetry/opentelemetry-python Error Handling Python observability 2025-03-18

  copy raw open
• Optimize configuration structureStructure configuration files like tox.ini to maximize maintainability and efficiency. Use factor prefixes (e.g., "test-opentelemetry:", ...

  open-telemetry/opentelemetry-python Configurations Other observability 2025-02-28

  copy raw open
• Follow Python naming conventionsUse consistent Python naming conventions to improve code readability and maintainability: 1. Use snake_case for functions and variables: ...

  open-telemetry/opentelemetry-python Naming Conventions Python observability 2024-07-04

  copy raw open
• Place attributes correctlyWhen implementing observability with OpenTelemetry, place attributes at the appropriate level in the telemetry hierarchy to ensure effect...

  open-telemetry/opentelemetry-python Observability Markdown observability 2025-06-24

  copy raw open
• Prevent recursive logging callsAvoid implementing logging calls that could trigger recursive logging patterns, which can lead to infinite loops and program crashes. Thi...

  open-telemetry/opentelemetry-python Logging Python observability 2025-05-15

  copy raw open
• Write reliable test casesCreate deterministic and reliable test cases by following these guidelines: 1. Use hardcoded values instead of random data to ensure repr...

  open-telemetry/opentelemetry-python Testing Python observability 2025-04-18

  copy raw open
• Precise configuration specificationsEnsure configuration files use tool-specific syntax and conventions while leveraging appropriate defaults. Be intentional about version c...

  open-telemetry/opentelemetry-python Configurations Toml observability 2025-03-08

  copy raw open
• Choose data structures wiselySelect data structures based on your specific access patterns and performance requirements. Using the right data structure can simplify y...

  open-telemetry/opentelemetry-python Algorithms Python observability 2024-09-02

  copy raw open
• Return collections not NoneReturn empty collections (lists, dicts, sets) instead of None when representing empty states. This reduces null checking boilerplate, pre...

  open-telemetry/opentelemetry-python Null Handling Python observability 2024-08-14

  copy raw open
• Pin dependency versionsAlways use exact version pinning (==) for dependencies in requirements files rather than version ranges. This ensures build reproducibili...

  open-telemetry/opentelemetry-python Configurations Txt observability 2024-07-30

  copy raw open
• Maintain consistent namingEnsure naming conventions are consistent across your codebase and related repositories. When naming commands, functions, variables, or at...

  open-telemetry/opentelemetry-python Naming Conventions Markdown observability 2025-03-07

  copy raw open
• Structured changelog documentationMaintain consistent and informative changelog documentation by following these practices: 1. Structure changelogs with an "Unreleased" se...

  open-telemetry/opentelemetry-python Documentation Markdown observability 2025-01-23

  copy raw open
• Explicit CI configurationsAlways use explicit, specific configurations in CI/CD pipelines to prevent ambiguity and conflicts. This includes: 1. **Clear environment...

  open-telemetry/opentelemetry-python CI/CD Other observability 2024-10-07

  copy raw open
• Use proper testing frameworksAlways leverage established testing frameworks and APIs over custom bash scripts or direct Python execution for test automation. Using pr...

  open-telemetry/opentelemetry-python Testing Shell observability 2025-06-23

  copy raw open
• Adapt for linter compatibilityWhen writing or modifying code, design patterns and templates to be compatible with linting tools. This is especially important for gener...

  open-telemetry/opentelemetry-python Code Style Other observability 2024-10-02

  copy raw open
• Telemetry version pinningWhen specifying observability frameworks like OpenTelemetry in requirements files, use the compatible release operator (~=) with only the...

  open-telemetry/opentelemetry-python Observability Txt observability 2024-07-11

  copy raw open
• Track observability API changesStay informed about API changes in observability libraries like OpenTelemetry, especially during their active development phases. Ensure ...

  open-telemetry/opentelemetry-python Observability Other observability 2020-03-03

  copy raw open