Skip to content

Commit 54be6b3

Browse files
Revise examples and enhance contribution section
Updated examples in README and added contribution guidelines.
1 parent b93fad4 commit 54be6b3

1 file changed

Lines changed: 67 additions & 14 deletions

File tree

README.md

Lines changed: 67 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,10 @@ multi-wing-standard/
149149
│ ├─ shared-context.schema.json
150150
│ └─ trace-reference.schema.json
151151
├─ examples/
152-
│ ├─ minimal-session.sample.json
153-
│ ├─ review-loop.sample.json
154-
│ ├─ trace-integrated.sample.json
155-
│ └─ edge-execution.sample.json
152+
│ ├─ wing-type.sample.json
153+
│ ├─ message-envelope.sample.json
154+
│ ├─ shared-context.sample.json
155+
│ └─ trace-reference.sample.json
156156
└─ .github/
157157
├─ workflows/
158158
│ └─ validate-specs.yml
@@ -407,7 +407,7 @@ from jsonschema import validate
407407
with open("schemas/message-envelope.schema.json", "r", encoding="utf-8") as f:
408408
schema = json.load(f)
409409
410-
with open("examples/minimal-session.sample.json", "r", encoding="utf-8") as f:
410+
with open("examples/message-envelope.sample.json", "r", encoding="utf-8") as f:
411411
sample = json.load(f)
412412
413413
validate(instance=sample, schema=schema)
@@ -463,9 +463,19 @@ Articles, essays, and explanatory materials may exist elsewhere, but this reposi
463463

464464
Contributions are welcome.
465465

466+
This repository is a specification repository, so contributions should prioritize:
467+
468+
- clarity
469+
- consistency
470+
- interoperability
471+
- testability
472+
- extensibility
473+
- accountability
474+
466475
Suggested contribution areas include:
467476

468477
- terminology refinement
478+
- specification clarifications
469479
- schema improvements
470480
- example workflows
471481
- interoperability mappings
@@ -475,24 +485,67 @@ Suggested contribution areas include:
475485

476486
Please read `CONTRIBUTING.md` before opening a pull request.
477487

478-
For substantial changes, open an issue first to discuss the proposal.
488+
For small editorial or schema-alignment fixes, a focused pull request is usually appropriate.
489+
For substantial changes to terminology, lifecycle behavior, core Wing types, schema expectations, profile boundaries, or conformance language, open an issue first so the proposal can be discussed before implementation work begins.
490+
491+
When opening a pull request, please describe:
492+
493+
- what changed
494+
- why it changed
495+
- whether the change is normative or informative
496+
- whether schemas or examples were updated
497+
- whether conformance implications exist
498+
499+
The goal is not only to improve the text, but to keep the specification structurally coherent as it evolves.
479500

480501
---
481502

482503
## Issue Types
483504

484-
You are encouraged to use GitHub Issues for:
505+
You are encouraged to use GitHub Issues before opening larger changes, especially when the proposal affects the normative structure of the specification.
506+
507+
This repository provides three issue templates:
508+
509+
### 1. Bug report
510+
Use this for problems such as:
485511

486-
- specification bugs
487-
- ambiguity reports
488-
- schema mismatches
489-
- interoperability concerns
490-
- profile proposals
491-
- extension proposals
492-
- security concerns
512+
- specification inconsistencies
513+
- schema validation failures
514+
- mismatches between schemas and examples
515+
- ambiguous required field behavior
516+
- broken references or version mismatches
517+
518+
### 2. Feature request
519+
Use this for proposals such as:
520+
521+
- new examples
522+
- new optional traits
523+
- profile enhancements
524+
- interoperability improvements
525+
- documentation expansions
526+
- non-breaking capability additions
527+
528+
### 3. Specification change
529+
Use this for substantive changes affecting the standard itself, such as:
530+
531+
- terminology revisions
532+
- lifecycle changes
533+
- required message field changes
534+
- Wing type changes
535+
- conformance rule changes
536+
- profile boundary changes
493537

494538
Suggested templates are provided in `.github/ISSUE_TEMPLATE/`.
495539

540+
When possible, include:
541+
542+
- the affected file or section
543+
- whether the issue is normative or informative
544+
- whether schemas or examples are impacted
545+
- whether backward compatibility may be affected
546+
547+
This helps keep discussion precise and makes it easier to review changes at the right architectural level.
548+
496549
---
497550

498551
## Versioning Policy

0 commit comments

Comments
 (0)