Skip to content

Commit 77a1753

Browse files
authored
Update ONBOARDING.md
1 parent 0abac17 commit 77a1753

File tree

1 file changed

+23
-36
lines changed

1 file changed

+23
-36
lines changed

ONBOARDING.md

Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ RESOLUTION.md — why any verb/schema changed
9494

9595
If a change is not consistent with these files, it is non-compliant, even if CI passes.
9696

97+
9798
## 4. How To Propose a Change
9899

99100
**Never** just “fix a schema” in a drive-by PR.
@@ -102,60 +103,46 @@ For any change (new verb, bugfix, tightening, etc.):
102103

103104
### 1. Open an Issue
104105

105-
Describe the problem / use case.
106-
107-
Specify which verb(s) and version(s) are affected.
108-
109-
Describe expected behavior vs current behavior.
106+
- Describe the problem / use case.
107+
- Specify which verb(s) and version(s) are affected.
108+
- Describe expected behavior vs current behavior.
110109

111110
### 2. Design the Change
112111

113-
Decide if this is breaking (shape or semantics) or additive.
114-
115-
Map it onto versioning rules in POLICY.md and SPEC.md.
116-
117-
For new verbs, justify why it belongs in Commons (not Commercial).
112+
- Decide if this is breaking (shape or semantics) or additive.
113+
- Map it onto versioning rules in POLICY.md and SPEC.md.
114+
- For new verbs, justify why it belongs in Commons (not Commercial).
118115

119116
### 3. Implement
120117

121-
Modify or add schemas under schemas/vX.Y.Z/...
122-
123-
Update examples under examples/vX.Y.Z/...
124-
125-
Run local validation:
126-
118+
- Modify or add schemas under schemas/vX.Y.Z/..
119+
- Update examples under examples/vX.Y.Z/...
120+
- Run local validation:
121+
```
127122
npm install
128123
npm run validate
129124
npm run validate:examples
130-
125+
```
131126

132127
### 4. Update Provenance
133128

134-
Append entries to RESOLUTION.md (what changed and why).
135-
136-
Prepare new checksums and manifest updates (if version changes).
137-
138-
Ensure new CIDs are ready to be pinned (IPFS).
129+
- Append entries to RESOLUTION.md (what changed and why).
130+
- Prepare new checksums and manifest updates (if version changes).
131+
- Ensure new CIDs are ready to be pinned (IPFS).
139132

140133
### 5. Submit PR
141134

142-
Link the Issue in the PR description.
143-
144-
Include validation output (or CI link).
145-
146-
Call out whether this is MAJOR/MINOR/PATCH in semantic-version terms.
135+
- Link the Issue in the PR description.
136+
- Include validation output (or CI link).
137+
- Call out whether this is MAJOR/MINOR/PATCH in semantic-version terms.
147138

148139
### 6. Governance Review
149140

150-
Maintainers check:
151-
152-
No silent breaking changes
153-
154-
Versioning rules respected
155-
156-
ENS TXT responsibility unchanged or correctly updated
157-
158-
Once merged, a new tag and CID are produced and recorded in SECURITY_PROVENANCE.md.
141+
- Maintainers check:
142+
- No silent breaking changes
143+
- Versioning rules respected
144+
- ENS TXT responsibility unchanged or correctly updated
145+
- Once merged, a new tag and CID are produced and recorded in SECURITY_PROVENANCE.md.
159146

160147
## 5. Local Dev / Validation
161148

0 commit comments

Comments
 (0)