dapr / dapr/community

Proposal to standardize the structure of Dapr SDK Readme files

Open
#497 0 comments 0 reactions 1 assignee Claimed by @marcduiker View on GitHub
Dominant language
No language data
Stars
183
Forks
78
PR merge metrics
No merged PRs in 30d

Description

@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](https://github.com/dapr/community/assets/4709852/baeb60d9-70c7-420d-8da0-3eb25b8e4579)

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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.