open-telemetry/semantic-conventions
Grade a repo

0

/ 100

GradeB

Good shape overall. A few tweaks would push it into the top tier.

Top 28% of 5,156 graded repos

Defines standards for generating consistent, accessible telemetry across a variety of domains

Documentation65
Engineering86
Health100
Open Policy Agent599Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

65

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt85

README is present.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under Apache-2.0.

Engineering

86

Tests18pt80

Test files detected (model/test).

Reproducibility6pt80

Lockfile present (package-lock.json). Installs are reproducible.

CI/CD14pt85

CI is configured (.github/workflows/build-system-check.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 368
    Forks
  • 24
    Releaseslatest 1y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 599
    Watchers

Responsiveness

  • 14h
    Median issue response
  • 2d 18h
    Median PR merge time
  • 693
    Open issues
Repository files34 root entries
  • .chloggen
  • .github
    Good: CI is configured (.github/workflows/build-system-check.yml).
    Good: Issue or PR templates present.
  • .vscode
  • docs
  • internal
  • model
    Good: Test files detected (model/test).
  • policies
  • policies_test
  • schemas
  • templates
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint-cli2.yaml
  • .markdownlint.yaml
  • .markdownlintignore
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierignore
  • .yamllint
  • .yamllint-ignore
  • AREAS.md
  • areas.yaml
  • Brewfile
  • CHANGELOG.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • dependencies.Dockerfile
  • issue-management.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • RELEASING.md
  • sigs-schema.json
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/open-telemetry/semantic-conventions)](https://www.repo-grade.com/report/open-telemetry/semantic-conventions)

More graded Open Policy Agent repos