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

Standard Structure for README.md in each WG repo #408

Closed
yash-yp opened this issue Apr 16, 2021 · 6 comments
Closed

Standard Structure for README.md in each WG repo #408

yash-yp opened this issue Apr 16, 2021 · 6 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@yash-yp
Copy link
Member

yash-yp commented Apr 16, 2021

Hi everyone,

While standardizing the repositories, I noticed that the README file of each working group has a different structure. After discussing with @GeorgLink, I have drafted a proposal for a common structure that can be implemented across these README files. I have also replicated the same as a template.

Link: https://docs.google.com/document/d/1pfipIiaemdtdiDQpvY7jOKhKzsv_3lXLLsbJiByl5GU/edit?usp=sharing

Please provide your thoughts and suggestions regarding the proposal.

@vinodkahuja
Copy link
Contributor

I have updated the readme as per the new standard template in the google doc (https://docs.google.com/document/d/1fQ0N3Pkv5qOXvzgF-9PuoDMafsmkh2DMPb0HTL665ps/edit) if it reads well I can create a pull request to update the readme.

Note: I have added @sgoggins as one of the chairs. Need to to add another wg chair to the readme.

@GeorgLink
Copy link
Member

@yash2002109 , can you please take a look at the repo and let us know here if there is anything still missing before we can close this issue?

@yash-yp
Copy link
Member Author

yash-yp commented Aug 20, 2021

Thanks @GeorgLink

I think we still need a PR to update the README.

@vinodkahuja, I see that the google doc has already been created. Could you please create a PR for this?

@GeorgLink GeorgLink added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Aug 20, 2021
@GeorgLink
Copy link
Member

Thanks @yash2002109. I see @vinodkahuja made a proposal and we need someone to create a PR now. We can leave this issue open until someone can pick this up.

@vinodkahuja
Copy link
Contributor

@GeorgLink I am ready to create a PR for this. I just need a confirmation from the WG. @sgoggins can you take a look and confirm. Also, provide a second chair for the WG.

@sgoggins
Copy link
Member

sgoggins commented Sep 7, 2021

LGTM.

vinodkahuja added a commit to vinodkahuja/wg-evolution that referenced this issue Sep 7, 2021
Refer issue chaoss#408 Updating readme as per standard format.

Signed-off-by: Vinod K. Ahuja <vahuja@unomaha.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants