Skip to content

Commit 4c36a98

Browse files
committed
Enforce asterisk Markdown list markers
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
1 parent 8464e75 commit 4c36a98

27 files changed

Lines changed: 252 additions & 248 deletions

File tree

.github/config/.rumdl.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# See https://rumdl.dev/
22
# and https://rumdl.dev/rules/
3+
[MD004]
4+
enabled = true
5+
style = "asterisk"
6+
37
[MD013]
48
enabled = true
59
line-length = 120

.github/copilot-instructions.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ This repository provides observability instrumentation for Java applications.
88

99
**PRIORITY**: Verify that all code changes follow the [Style Guide](../docs/style-guide.md). Check:
1010

11-
- Code formatting (auto-formatting, static imports, class organization)
12-
- Java language conventions (`final` usage, `@Nullable` annotations, `Optional` usage)
13-
- Performance constraints (hot path allocations)
14-
- Implementation patterns (SPI registration, configuration conventions)
15-
- Gradle conventions (Kotlin DSL, plugin usage, module naming)
16-
- Documentation standards (README files, deprecation processes)
11+
* Code formatting (auto-formatting, static imports, class organization)
12+
* Java language conventions (`final` usage, `@Nullable` annotations, `Optional` usage)
13+
* Performance constraints (hot path allocations)
14+
* Implementation patterns (SPI registration, configuration conventions)
15+
* Gradle conventions (Kotlin DSL, plugin usage, module naming)
16+
* Documentation standards (README files, deprecation processes)
1717

1818
### Critical Areas
1919

20-
- **Public APIs**: Changes affect downstream users and require careful review
21-
- **Performance**: Instrumentation must have minimal overhead
22-
- **Thread Safety**: Ensure safe concurrent access patterns
23-
- **Memory Management**: Prevent leaks and excessive allocations
20+
* **Public APIs**: Changes affect downstream users and require careful review
21+
* **Performance**: Instrumentation must have minimal overhead
22+
* **Thread Safety**: Ensure safe concurrent access patterns
23+
* **Memory Management**: Prevent leaks and excessive allocations
2424

2525
### Quality Standards
2626

27-
- Proper error handling with appropriate logging levels
28-
- OpenTelemetry specification and semantic convention compliance
29-
- Resource cleanup and lifecycle management
30-
- Comprehensive unit tests for new functionality
27+
* Proper error handling with appropriate logging levels
28+
* OpenTelemetry specification and semantic convention compliance
29+
* Resource cleanup and lifecycle management
30+
* Comprehensive unit tests for new functionality
3131

3232
### Test suites
3333

.github/repository-settings.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,32 @@ private admin repo.
88

99
[The admin repo doesn't currently support tracking merge queue settings.]
1010

11-
- Require merge queue: CHECKED
12-
- Build concurrency: 5
13-
- Maximum pull requests to build: 5
14-
- Minimum pull requests to merge: 1, or after 5 minutes
15-
- Maximum pull requests to merge: 5
16-
- Only merge non-failing pull requests: CHECKED
17-
- Status check timeout: 60 minutes
11+
* Require merge queue: CHECKED
12+
* Build concurrency: 5
13+
* Maximum pull requests to build: 5
14+
* Minimum pull requests to merge: 1, or after 5 minutes
15+
* Maximum pull requests to merge: 5
16+
* Only merge non-failing pull requests: CHECKED
17+
* Status check timeout: 60 minutes
1818

1919
## Secrets and variables > Actions
2020

2121
### Repository secrets
2222

23-
- `GPG_PASSWORD` - stored in OpenTelemetry-Java 1Password
24-
- `GPG_PRIVATE_KEY` - stored in OpenTelemetry-Java 1Password
25-
- `SONATYPE_GUIDE_PAT` - owned by [@trask](https://github.com/trask)
26-
- `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
27-
- `SONATYPE_USER` - owned by [@trask](https://github.com/trask)
23+
* `GPG_PASSWORD` - stored in OpenTelemetry-Java 1Password
24+
* `GPG_PRIVATE_KEY` - stored in OpenTelemetry-Java 1Password
25+
* `SONATYPE_GUIDE_PAT` - owned by [@trask](https://github.com/trask)
26+
* `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
27+
* `SONATYPE_USER` - owned by [@trask](https://github.com/trask)
2828

2929
### Organization secrets
3030

31-
- `CODECOV_TOKEN`
32-
- `DEVELOCITY_ACCESS_KEY` (scoped only to Java repos)
33-
- `FOSSA_API_KEY`
34-
- `OTELBOT_PRIVATE_KEY`
31+
* `CODECOV_TOKEN`
32+
* `DEVELOCITY_ACCESS_KEY` (scoped only to Java repos)
33+
* `FOSSA_API_KEY`
34+
* `OTELBOT_PRIVATE_KEY`
3535

3636
### Organization variables
3737

38-
- `OSSF_SCORECARD_APP_ID`
39-
- `OTELBOT_APP_ID`
38+
* `OSSF_SCORECARD_APP_ID`
39+
* `OTELBOT_APP_ID`

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ See [Style Guide](docs/style-guide.md).
6363

6464
When submitting a pull request, please ensure that you:
6565

66-
- Clearly describe the change and its motivation
67-
- Mention any breaking changes
68-
- Include tests for new functionality
69-
- Follow the [Style Guide](docs/style-guide.md)
66+
* Clearly describe the change and its motivation
67+
* Mention any breaking changes
68+
* Include tests for new functionality
69+
* Follow the [Style Guide](docs/style-guide.md)
7070

7171
## Getting Help
7272

7373
If you need assistance or have questions:
7474

75-
- Post on the [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) Slack channel
76-
- [Open an issue](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/new/choose) in
75+
* Post on the [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) Slack channel
76+
* [Open an issue](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/new/choose) in
7777
this repository

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,26 +56,26 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
5656

5757
### Maintainers
5858

59-
- [Jack Berg](https://github.com/jack-berg), Grafana Labs
60-
- [Jason Plumb](https://github.com/breedx-splk), Splunk
61-
- [Jay DeLuca](https://github.com/jaydeluca), Grafana Labs
62-
- [Lauri Tulmin](https://github.com/laurit), Splunk
63-
- [Trask Stalnaker](https://github.com/trask), Microsoft
59+
* [Jack Berg](https://github.com/jack-berg), Grafana Labs
60+
* [Jason Plumb](https://github.com/breedx-splk), Splunk
61+
* [Jay DeLuca](https://github.com/jaydeluca), Grafana Labs
62+
* [Lauri Tulmin](https://github.com/laurit), Splunk
63+
* [Trask Stalnaker](https://github.com/trask), Microsoft
6464

6565
For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
6666

6767
### Approvers
6868

69-
- [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana Labs
70-
- [John Watson](https://github.com/jkwatson), Sublime Security
69+
* [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana Labs
70+
* [John Watson](https://github.com/jkwatson), Sublime Security
7171

7272
For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
7373

7474
### Emeritus maintainers
7575

76-
- [Mateusz Rzeszutek](https://github.com/mateuszrzeszutek)
77-
- [Nikita Salnikov-Tarnovski](https://github.com/iNikem)
78-
- [Ryan Fitzpatrick](https://github.com/rmfitzpatrick)
76+
* [Mateusz Rzeszutek](https://github.com/mateuszrzeszutek)
77+
* [Nikita Salnikov-Tarnovski](https://github.com/iNikem)
78+
* [Ryan Fitzpatrick](https://github.com/rmfitzpatrick)
7979

8080
For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager).
8181

aws-resources/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This module contains AWS resource detectors including Beanstalk, EC2, ECS, EKS,
44

55
## Component owners
66

7-
- [Lei Wang](https://github.com/wangzlei), AWS
8-
- [Prashant Srivastava](https://github.com/srprash), AWS
7+
* [Lei Wang](https://github.com/wangzlei), AWS
8+
* [Prashant Srivastava](https://github.com/srprash), AWS
99

1010
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

aws-xray-propagator/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ the [AWS X-Ray Trace Header propagation protocol](https://docs.aws.amazon.com/xr
55

66
## Component owners
77

8-
- [Lei Wang](https://github.com/wangzlei), AWS
9-
- [Prashant Srivastava](https://github.com/srprash), AWS
8+
* [Lei Wang](https://github.com/wangzlei), AWS
9+
* [Prashant Srivastava](https://github.com/srprash), AWS
1010

1111
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

aws-xray/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This module contains a custom `IdGenerator` and `Sampler` for use with AWS X-Ray
44

55
## Component owners
66

7-
- [Lei Wang](https://github.com/wangzlei), AWS
8-
- [Prashant Srivastava](https://github.com/srprash), AWS
7+
* [Lei Wang](https://github.com/wangzlei), AWS
8+
* [Prashant Srivastava](https://github.com/srprash), AWS
99

1010
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

azure-resources/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The following OpenTelemetry semantic conventions will be detected:
2929

3030
## Component Owners
3131

32-
- [Trask Stalnaker](https://github.com/trask), Microsoft
33-
- [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana
32+
* [Trask Stalnaker](https://github.com/trask), Microsoft
33+
* [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana
3434

3535
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

baggage-processor/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ new BaggageLogRecordProcessor(baggageKey -> pattern.matcher(baggageKey).matches(
9494

9595
## Component owners
9696

97-
- [Mike Golsmith](https://github.com/MikeGoldsmith), Honeycomb
98-
- [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana
97+
* [Mike Golsmith](https://github.com/MikeGoldsmith), Honeycomb
98+
* [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana
9999

100100
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

0 commit comments

Comments
 (0)