-
Notifications
You must be signed in to change notification settings - Fork 32
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
chore: Update README.md #178
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some grammar nits. I wish we had a readme template for spec repos to adopt.
Co-authored-by: Anssi Kostiainen <[email protected]>
@anssiko see the Geolocation one. I think it’s quite good, as it gives a good overview of the API and purpose. We could do something like that here as a follow up. |
Geolocation API readme examples are great and could be contributed to MDN developer docs when appropriate to reach more web developers. I was thinking of a minimal baseline spec repo readme with information on how to contribute, how to build. Something that first into one page. I'm fine with repos having custom readmes, it gives them character. |
SHA: 1366d29 Reason: push, by marcoscaceres Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
MDN has a really good guide I guess if anything, we should probably remove the examples from the Geo README and point people to that 😅 (and maybe we could modernize what's on MDN).
I still think that's better handled by the CONTRIBUTING.md ... For instance, the one for Web Manifest contains how to build instructions, style guide, etc. https://github.com/w3c/manifest/blob/main/.github/CONTRIBUTING.md I personally prefer keep the READMEs minimal and without any duplicative information.... more like, if you want to contribute, read CONTRIBUTE.md, if you want to do Y, read Y.MD... and so on. |
Update README to reflect joint deliverable status.