Skip to content

DevRel project README template #414

Open
@seymen

Description

@seymen

We have some concerns that some of the README content are missing some sections which might be helpful when/if you would like to use them in demos. Installation is generally not a problem (due to pipeline), but once you install one of the more complicated projects, it is sometimes difficult to understand what features and functionalities have been implemented and the best way to demo them to others.

In order to solve this problem and also to put some structure to the READMEs, it is proposed that we create a template to guarantee consistent information in our READMEs.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions