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.

Sign up for GitHub

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

Jump to bottom

Document each example with a README.md #202

Closed
salcode opened this issue Mar 28, 2022 · 2 comments
Closed

Document each example with a README.md #202

salcode opened this issue Mar 28, 2022 · 2 comments

Comments

@salcode
Copy link
Contributor

salcode commented Mar 28, 2022

@Pixelrobin already opened PR #52 (which adds README.md files for 01 through 05) but that appears to have stalled out.

I wanted to create this issue to confirm the maintainers are in favor of adding these files.

As a sidenote: I suspect if we open a smaller PR to add a README.md to just 01-basic-esnext as a starting point, it will be easier to address any issues and get it merged.
@salcode salcode mentioned this issue Mar 28, 2022
Merged
@metalandcoffee
Copy link

As a sidenote: I suspect if we open a smaller PR to add a README.md to just 01-basic-esnext as a starting point, it will be easier to address any issues and get it merged.

I definitely agree with this. The first PR for to add a README.md to an example block should set the standard and wording and then future README.md PRs should try to model the first one for consistency 👍
@salcode
Copy link
Contributor Author

salcode commented Mar 28, 2022

On my first pass I overlooked #45, which already covers this.

Closing this duplicate issue.
@salcode salcode closed this as completed Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants
@salcode @metalandcoffee