Skip to content

Commit 8517799

Browse files
committed
chore: add prose rules to CLAUDE.md and apply them
1 parent 00815ba commit 8517799

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,21 @@ The metric definitions were produced by:
4545
- Deprecated Prometheus aliases (e.g., `dash0_spans_total`) get their own metric group entry with `deprecated: { reason: renamed, renamed_to: <otel_name> }`.
4646
- Every metric **must** have a `unit` field compliant with [UCUM](https://ucum.org/).
4747

48+
## Prose rules
49+
50+
Follow these rules when writing or editing prose in this project.
51+
52+
- **One sentence per line** (semantic line breaks).
53+
Each sentence starts on its own line; do not wrap mid-sentence.
54+
- Separate paragraphs with a single blank line.
55+
- Section headers use sentence case (e.g., "Key conventions").
56+
- Use inline Markdown links: `[visible text](url)`.
57+
Link the most specific relevant term, not generic phrases.
58+
- Fence code blocks with triple backticks and a language identifier (e.g., ` ```yaml `).
59+
- End sentences with full stops.
60+
- Use the **Oxford comma** (e.g., "spans, logs, and metrics").
61+
- Write numbers as digits and spell out "percent" (e.g., "10 percent").
62+
4863
## README.md maintenance
4964

5065
The `Conventions` section in `README.md` is a hand-maintained summary. When adding, removing, or renaming attributes, metrics, or events in the `model/` directory, update the corresponding entry in `README.md`:

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
Contributing
2-
============
1+
# Contributing
32

43
## Prerequisites
54

65
- Signing the [Contributor License Agreement](https://github.com/cla-assistant/cla-assistant)
76
- [OTel Weaver](https://github.com/open-telemetry/weaver) (v0.21.2+)
87
- Node.js (LTS) — used for converting JSON5 test data
98

10-
## Making Changes to the Model
9+
## Making changes to the model
1110

12-
The semantic conventions are defined as YAML files under the `model/` directory, using the [OpenTelemetry Weaver](https://github.com/open-telemetry/weaver) registry format.
11+
The semantic conventions are defined as YAML files under the `model/` directory.
12+
They use the [OpenTelemetry Weaver](https://github.com/open-telemetry/weaver) registry format.
1313

1414
- `model/registry_manifest.yaml` — Registry manifest declaring dependencies (e.g., on OTel semantic conventions).
1515
- `model/<domain>/entities.yaml` — Entity definitions.
@@ -21,7 +21,7 @@ When adding or modifying conventions:
2121
2. Run `weaver registry check -r ./model` to validate the model.
2222
3. Add or update test data under `tests/`.
2323

24-
## Test Data
24+
## Test data
2525

2626
Test data lives under the `tests/` directory as [JSON5](https://json5.org/) files:
2727

@@ -30,7 +30,7 @@ Test data lives under the `tests/` directory as [JSON5](https://json5.org/) file
3030

3131
When adding a new event or entity, add at least one valid and one invalid test case.
3232

33-
## Validating Locally
33+
## Validating locally
3434

3535
Check the registry model for correctness:
3636

@@ -66,7 +66,7 @@ for file in $(find tests/invalid -name '*.json5' | sort); do
6666
done
6767
```
6868

69-
## Pull Requests
69+
## Pull requests
7070

7171
All pull requests are validated in CI, which runs:
7272

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Dash0 Semantic Conventions
22

33
This repository contains the semantic conventions for [Dash0](https://www.dash0.com).
4-
The conventions are defined using the [OpenTelemetry Weaver](https://github.com/open-telemetry/weaver) registry format and build on top of the [OpenTelemetry Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/).
4+
The conventions are defined using the [OpenTelemetry Weaver](https://github.com/open-telemetry/weaver) registry format.
5+
They build on top of the [OpenTelemetry Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/).
6+
7+
The full registry documentation is published at [dash0hq.github.io/dash0-semantic-conventions](https://dash0hq.github.io/dash0-semantic-conventions/).
8+
This is a temporary location; the content will be merged into the [Dash0 Docs](https://docs.dash0.com) in a future release.
59

610
## Conventions
711

0 commit comments

Comments
 (0)