-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationneeds-triageRequires triage and prioritizationRequires triage and prioritization
Description
Description
The OSSF Silver badge requires projects to describe the software architecture (the software components, the interfaces between them, and the data flow) in the contribution documentation.
OSSF Criterion: documentation_architecture (MUST)
Reference: https://www.bestpractices.dev/en/projects/11532?criteria_level=1#documentation_architecture
Current Gap
| Criterion | Requirement | Current State |
|---|---|---|
documentation_architecture |
Describe software architecture in contribution documentation | No architecture documentation exists |
Proposed Deliverable
Create docs/architecture.md with:
- High-level component overview
- Interface descriptions between components
- Data flow diagrams or descriptions
- Directory structure explanation
Acceptance Criteria
- Create
docs/architecture.mdat minimum 500 words - Include diagram or visual representation of component relationships
- Document interfaces between major components:
- Extension component
- Scripts component
- Skills component
- Documentation component
- Describe data flow for primary workflows
- Link architecture doc from README.md or CONTRIBUTING.md
- Update OSSF badge form to mark
documentation_architectureas Met
Additional Context
- OSSF Badge Project: https://www.bestpractices.dev/en/projects/11532
- This issue is part of Silver badge compliance work tracked in the research document
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationneeds-triageRequires triage and prioritizationRequires triage and prioritization