Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pdebruin opened this issue Jun 11, 2024 · 0 comments
Open

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

pdebruin opened this issue Jun 11, 2024 · 0 comments
Assignees

Comments

@pdebruin
Copy link

@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?

@marcduiker marcduiker self-assigned this Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants