dapr / community

Governance and community material for Dapr and its open source sub-projects
Apache License 2.0
140 stars 61 forks source link

Proposal to standardize the structure of Dapr SDK Readme files #497

Open pdebruin opened 3 months ago

pdebruin commented 3 months ago

@marcduiker and I discussed the experience for new users and contributors of Dapr. One of the observations is that currently the contents of Readme files in SDK repos is not uniform, which means their experience can vary depending on where they land. The image shows a table with Dapr repos in columns and Readme contents in rows below. image

The proposal part of this issue is open for discussion :-)

Getting started, documentation, contributing, and code of conduct seem to be common in the five repos. Should releases, examples, community and good first issues be part of the standard readme too?