-
Notifications
You must be signed in to change notification settings - Fork 13
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Description
As a developer,
I want to improve the README.md file in compliance with TRG 1.01,
so that users and contributors can quickly understand the purpose, setup, and usage of the project, following Eclipse Tractus-X standards.
Acceptance Criteria
- Add basic repository overview, purpose, and structure
- Include installation instructions (or reference
INSTALL.mdif complex) - Provide usage examples and intended use
- Add license information
- Include troubleshooting tips and FAQs
- Reference the
CONTRIBUTING.mdfile for contribution guidelines - Add contact or support information
- Display useful badges (build status, coverage, etc.)
- Link architecture, admin, user, and API documentation if available (TRG 1.05–1.08)
Additional Information
- Based on TRG 1.01 – README.md in the Eclipse Tractus-X Release Guidelines
- For complex installations, use
INSTALL.md(TRG 1.02)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
In Progress