Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit da88f81

Browse files
roottoolclaude
andauthored
docs: fix textlint violations in documentation (#57)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 918d254 commit da88f81

8 files changed

Lines changed: 22 additions & 22 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Type of Change
66

7-
- [ ] Bug fix (non-breaking change fixing an issue)
7+
- [ ] Bugfix (non-breaking change fixing an issue)
88
- [ ] Security fix (non-breaking change addressing a security issue)
99
- [ ] Documentation (changes to documentation only)
1010
- [ ] Refactoring (non-breaking change improving code structure)
@@ -27,7 +27,7 @@
2727
- Key names are treated as opaque strings
2828
- No structural inference (`[]`, `.`, brackets, paths, etc.)
2929
- [ ] **No silent behavior**
30-
- No merging, overwriting, auto-fixing, or implicit resolution
30+
- No merging, overwriting, autofixing, or implicit resolution
3131
- All boundary violations are reported explicitly
3232
- [ ] **Boundary respected**
3333
- No validation, coercion, schema, framework conventions, or business logic

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ This project uses GitHub Releases as the single source of truth for all changes.
55
For the full and authoritative change history, including breaking changes and migration notes,
66
please see: <https://github.com/roottool/safe-formdata/releases>
77

8-
No additional change log is maintained in this file.
8+
No additional changelog is maintained in this file.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ It enforces strict rules on keys and forbids structural inference by design.
3838
## Overview
3939

4040
FormData is untyped and unstructured by nature.
41-
Many parsers attempt to infer structure or semantics from key naming conventions.
41+
Parsers often attempt to infer structure or semantics from key naming conventions.
4242

4343
safe-formdata intentionally does not.
4444

@@ -85,7 +85,7 @@ Security decisions and issue triage are based on the definitions in SECURITY.md.
8585

8686
## Design decisions (Why not?)
8787

88-
safe-formdata intentionally omits several common features.
88+
safe-formdata intentionally omits the following common features.
8989

9090
### Why no structural inference?
9191

@@ -197,7 +197,7 @@ if (result.data !== null) {
197197
}
198198
```
199199

200-
**Key points**
200+
### Key points
201201

202202
- All values are `string | File` - no automatic type conversion
203203
- Use `data !== null` to check for success and narrow the type

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Users must upgrade to the latest version to receive security patches.
2525

2626
## Public vs Private Reporting
2727

28-
safe-formdata distinguishes clearly between **private vulnerability disclosure**
28+
safe-formdata distinguishes between **private vulnerability disclosure**
2929
and **public security discussion**.
3030

3131
### Private (Security Advisory)

docs/PUBLISHING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ This runs the following steps.
3333

3434
1. **Prepare Release PR**: Bump version → Create release branch → Open PR for review
3535
2. **Review & Merge**: Maintainer reviews and merges release PR to main
36-
3. **Publish**: Manual trigger of publish workflow → All checks run → NPM publish
36+
3. **Publish**: Manual trigger of publish workflow → All checks run → npm publish
3737

3838
The publish workflow is defined in `.github/workflows/publish.yml` and runs the following steps:
3939

4040
1. Setup environment (Bun + dependencies)
4141
2. **Validate and build package** (`bun run prepare:publish`)
42-
3. Setup Node.js for NPM
43-
4. Publish to NPM with provenance
44-
5. Create and push git tag
42+
3. Setup Node.js for npm
43+
4. Publish to npm with provenance
44+
5. Create and push Git tag
4545
6. Create GitHub Release (draft)
4646

4747
---

skills/boundary-validator/examples/bad-code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ function parse(formData: FormData): any {
160160
// Violates: No silent behavior
161161
```
162162

163-
### ❌ Object.assign / Spread Operator
163+
### ❌ Object.assign / spread syntax
164164

165165
```typescript
166166
// ❌ WRONG: Using Object.assign (merges)
@@ -488,7 +488,7 @@ export type ParseResult =
488488

489489
---
490490

491-
## Testing Anti-Patterns
491+
## Testing antipatterns
492492

493493
### ❌ Not Testing Forbidden Keys
494494

skills/boundary-validator/references/api-contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ For complete versioning policy, see README.md Versioning section.
241241

242242
### Key Points
243243

244-
- **Patch versions** (0.1.x): Bug fixes, no API changes
244+
- **Patch versions** (0.1.x): bugfixes, no API changes
245245
- **Minor versions** (0.x.0): Non-breaking additions (with caution in 0.x)
246246
- **Major versions** (1.0.0+): Breaking changes allowed
247247

@@ -259,7 +259,7 @@ The following changes are **breaking** and require a major version bump:
259259

260260
The following changes are **non-breaking** and allowed in minor/patch versions:
261261

262-
- Bug fixes in parsing logic
262+
- Bugfixes in parsing logic
263263
- Performance improvements
264264
- Internal refactoring
265265
- Documentation improvements

skills/boundary-validator/references/validation-patterns.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Use these patterns when reviewing code changes to safe-formdata.
88

99
## Detection Strategy
1010

11-
When reviewing code, search for these anti-patterns.
11+
When reviewing code, search for these antipatterns.
1212

1313
1. **Keyword search**: Look for suspicious method calls and operators
1414
2. **Control flow analysis**: Examine conditional logic related to keys
@@ -18,7 +18,7 @@ When reviewing code, search for these anti-patterns.
1818

1919
## Rule 1: Keys are Opaque Strings
2020

21-
### Anti-Patterns to Detect
21+
### Antipatterns to Detect
2222

2323
#### Pattern: Bracket Notation Parsing
2424

@@ -82,7 +82,7 @@ if (key === "exact_key_name") {
8282

8383
## Rule 2: No Silent Behavior
8484

85-
### Anti-Patterns to Detect
85+
### Antipatterns to Detect
8686

8787
#### Pattern: Merge/Overwrite
8888

@@ -151,7 +151,7 @@ for (const [key, value] of formData.entries()) {
151151

152152
## Rule 3: No Inference, No Convenience
153153

154-
### Anti-Patterns to Detect
154+
### Antipatterns to Detect
155155

156156
#### Pattern: Structural Inference
157157

@@ -248,7 +248,7 @@ export function parse(formData: FormData): ParseResult {
248248

249249
## Rule 4: Explicit Issue Reporting
250250

251-
### Anti-Patterns to Detect
251+
### Antipatterns to Detect
252252

253253
#### Pattern: Throwing Exceptions
254254

@@ -321,7 +321,7 @@ return { data, issues: [] };
321321

322322
## Security-Specific Patterns
323323

324-
### Anti-Patterns to Detect
324+
### Antipatterns to Detect
325325

326326
#### Pattern: Unsafe Object Creation
327327

@@ -376,7 +376,7 @@ for (const [key, value] of formData.entries()) {
376376

377377
## API Contract Patterns
378378

379-
### Anti-Patterns to Detect
379+
### Antipatterns to Detect
380380

381381
#### Pattern: Function Overloads
382382

0 commit comments

Comments
 (0)