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

DevRel project README template #414

Open
seymen opened this issue Nov 1, 2021 · 1 comment
Open

DevRel project README template #414

seymen opened this issue Nov 1, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@seymen
Copy link
Collaborator

seymen commented Nov 1, 2021

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.

@seymen seymen self-assigned this Nov 1, 2021
@yuriylesyuk
Copy link
Collaborator

let me take this one

@seymen seymen assigned yuriylesyuk and unassigned seymen Nov 1, 2021
@danistrebel danistrebel added the documentation Improvements or additions to documentation label Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants