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

chore: Update README.md #178

Merged
merged 3 commits into from
May 14, 2024
Merged

chore: Update README.md #178

merged 3 commits into from
May 14, 2024

Conversation

marcoscaceres
Copy link
Member

Update README to reflect joint deliverable status.

@rakuco rakuco requested a review from anssiko May 8, 2024 07:11
Copy link
Member

@anssiko anssiko left a 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.

README.md Outdated Show resolved Hide resolved
@marcoscaceres
Copy link
Member Author

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

@anssiko
Copy link
Member

anssiko commented May 13, 2024

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.

@marcoscaceres marcoscaceres merged commit 1366d29 into main May 14, 2024
2 checks passed
@marcoscaceres marcoscaceres deleted the marcoscaceres-patch-1 branch May 14, 2024 05:03
github-actions bot added a commit that referenced this pull request May 14, 2024
SHA: 1366d29
Reason: push, by marcoscaceres

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@marcoscaceres
Copy link
Member Author

marcoscaceres commented May 14, 2024

Geolocation API readme examples are great and could be contributed to MDN developer docs when appropriate to reach more web developers.

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 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.

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.

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

Successfully merging this pull request may close these issues.

3 participants