Skip to content

Commit a77902a

Browse files
committed
Review feedback
1 parent b4ea171 commit a77902a

File tree

8 files changed

+13
-11
lines changed

8 files changed

+13
-11
lines changed

.textlintrc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ rules:
2525
defaultTerms: true
2626
skip: []
2727
exclude:
28+
- 'bug[- ]fix(es)?'
2829
- 'readme(s)?'
2930
- 'to-?do(s)?(?=[ ,.])'
3031
terms:
@@ -124,7 +125,7 @@ rules:
124125
- ['3rd[- ]party', third-party]
125126
- ['auto[- ]c(onfigur)(es?|ations?)', 'autoc$1$2'] # cSpell:disable-line
126127
- ['back[- ]end(s)?', 'backend$1']
127-
- [bugfix, bug fix]
128+
- ['bugfix(es?)', 'bug fix$1']
128129
- [byte code, bytecode]
129130
- ['(cloud)-(native)', '$1 $2']
130131
- [cpp, C++]
@@ -181,3 +182,4 @@ rules:
181182
# Enable the following to find and replace "instrumentation module/package" with "instrumentation library":
182183
# - ["(auto(matic)?[- ])?instrumentation (module|package)", "instrumentation library"]
183184
# - ["(auto(matic)?[- ])?instrumentation (modules|packages)", "instrumentation libraries"]
185+
- snake_case

oteps/0143-versioning-and-stability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ Most changes to OpenTelemetry result in a minor version bump.
132132
**Patch version bump**
133133
Patch versions make no changes which would require recompilation or potentially break application code. The following are examples of patch fixes.
134134

135-
* Bugfixes which don't require minor version bump per rules above.
135+
* Bug fixes which don't require minor version bump per rules above.
136136
* Security fixes.
137137
* Documentation.
138138

139-
Currently, OpenTelemetry does NOT have plans to backport bug and security fixes to prior minor versions. Security and bugfixes are only applied to the latest minor version. We are committed to making it feasible for end users to stay up to date with the latest version of OpenTelemetry.
139+
Currently, OpenTelemetry does NOT have plans to backport bug and security fixes to prior minor versions. Security and bug fixes are only applied to the latest minor version. We are committed to making it feasible for end users to stay up to date with the latest version of OpenTelemetry.
140140

141141
## Long Term Support
142142

oteps/0147-upgrade-procedures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ The primary blocker to upgrading the SDK is out of date Plugins. If a new versio
5353

5454
By following a deprecation pattern with Plugin Interfaces, we create a one year window in which the Plugin ecosystem can upgrade after the release of a new SDK. We believe this is sufficient time for any Plugin which is actively maintained to make an upgrade, and for defunct Plugins to be identified and replaced.
5555

56-
By ensuring that the SDK can be easily upgraded, we also provide a path for application owners and operators to rapidly consume critical bugfixes and security patches, without the need to backport these patches across a large number of prior SDK versions.
56+
By ensuring that the SDK can be easily upgraded, we also provide a path for application owners and operators to rapidly consume critical bug fixes and security patches, without the need to backport these patches across a large number of prior SDK versions.

oteps/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ In practice, this means that OTEPs should be used for such changes as:
3636

3737
On the other hand, they do not need to be used for such changes as:
3838

39-
- Bugfixes
39+
- Bug fixes
4040
- Rephrasing, grammatical fixes, typos, etc.
4141
- Refactoring
4242
- Things that affect only a single language or implementation

oteps/entities/0256-entities-data-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ events as a liveliness indicator).
380380

381381
The expiration mechanism is based on the previously reported `Interval` field of
382382
EntityState event. The recipient can use this value to compute when to expect the next
383-
EntityState event and if the event does not arrive in a timely manner (plus some Slack)
383+
EntityState event and if the event does not arrive in a timely manner (plus some tolerance)
384384
it can consider the entity to be gone even if the EntityDelete event was not observed.
385385

386386
## Entity Identification

specification/library-layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ api
2323
└── logs
2424
```
2525

26-
> Use of lowercase, camelCase or snake_case (stylized as snake_case) names depends on the language.
26+
> Use of lowercase, camelCase or snake_case names depends on the language.
2727
2828
### `/api/context`
2929

@@ -74,7 +74,7 @@ sdk
7474
└── logs
7575
```
7676

77-
> Use of lowercase, camelCase or snake_case (stylized as snake_case) names depends on the language.
77+
> Use of lowercase, camelCase or snake_case names depends on the language.
7878
7979
### `/sdk/context`
8080

specification/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,5 @@ We believe this is sufficient time for any Plugin which is actively maintained
160160
to make an upgrade, and for defunct Plugins to be identified and replaced.
161161

162162
By ensuring that the SDK can be easily upgraded, we also provide a path for application
163-
owners and operators to rapidly consume critical bugfixes and security patches,
163+
owners and operators to rapidly consume critical bug fixes and security patches,
164164
without the need to backport these patches across a large number of prior SDK versions.

specification/versioning-and-stability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,12 +387,12 @@ Most changes to OpenTelemetry clients result in a minor version bump.
387387
Patch versions make no changes which would require recompilation or potentially break application code.
388388
The following are examples of patch fixes.
389389

390-
* Bugfixes which don't require minor version bump per rules above.
390+
* Bug fixes which don't require minor version bump per rules above.
391391
* Security fixes.
392392
* Documentation.
393393

394394
Currently, the OpenTelemetry project does NOT have plans to backport bug and security fixes to prior minor versions of the SDK.
395-
Security and bugfixes MAY only be applied to the latest minor version.
395+
Security and bug fixes MAY only be applied to the latest minor version.
396396
We are committed to making it feasible for end users to stay up to date with the latest version of the OpenTelemetry SDK.
397397

398398
### Language version support

0 commit comments

Comments
 (0)