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 #358

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

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

yash-yp opened this issue Apr 16, 2021 · 5 comments
Labels
I: good first issue Good for newcomers I: help wanted Extra attention is needed T: improvement Improves on something that already exists

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.

@GeorgLink
Copy link
Member

I think the DEI WG repo now uses the correct README format.

@yash2002109, can you please confirm that this work is complete and we can close the issue?

@yash-yp
Copy link
Member Author

yash-yp commented Aug 20, 2021

Thanks, @GeorgLink,

In discussion with WGs, we decided to remove the meeting details from the README and redirect the user to the Participate section on the website. We also discussed with the community to add the Chairs instead of WG-maintainers.

Also, please refer to the template: https://docs.google.com/document/d/1pfipIiaemdtdiDQpvY7jOKhKzsv_3lXLLsbJiByl5GU/edit
to make sure the order in which the information is presented gets followed.

The Common WG README can be used as a reference. It would be great if a WG member could take an AI to draft the README.

@GeorgLink
Copy link
Member

Thanks @yash2002109 , we can leave the issue open until the WG has time to address it.

@GeorgLink GeorgLink added T: improvement Improves on something that already exists I: good first issue Good for newcomers I: help wanted Extra attention is needed labels Aug 20, 2021
@ElizabethN
Copy link
Member

The WG discussed this today, and there are a few PRs that we think addressed this #356 and Issue #346. Going to close this for now, but we can re-open if needed.
cc @GeorgLink @yash2002109

@GeorgLink
Copy link
Member

Thanks for the Ping. I think we are all good for now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: good first issue Good for newcomers I: help wanted Extra attention is needed T: improvement Improves on something that already exists
Projects
None yet
Development

No branches or pull requests

3 participants