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

📝 docs: fix misc typos #174

Merged
merged 2 commits into from Oct 17, 2022
Merged

Conversation

xavdid
Copy link
Contributor

@xavdid xavdid commented Oct 17, 2022

PR Checklist

Overview

Fixes a few small inconsistencies in docs / TS templates. Should be self-explanatory, but I'm happy to explain any that are unclear.

Once I finish reading the book, I'll probably do a pass to ensure the comments at the top of each index.ts match what the README is asking for; I've just been filing these as I found them.

Also if I want to get in the "All Contributors" section (assuming I qualify), do I edit that file manually or go through a bot? CONTRIBUTING.md was unclear on that point.

Thanks!


Separately, do you have a preferred avenue for typos in the text of the book itself? I found a small one but didn't see a place to fix it.

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic, thanks so much @xavdid! 🙌

@JoshuaKGoldberg
Copy link
Contributor

Also if I want to get in the "All Contributors" section (assuming I qualify), do I edit that file manually or go through a bot? CONTRIBUTING.md was unclear on that point.

Good point, that should be documented.

@JoshuaKGoldberg
Copy link
Contributor

JoshuaKGoldberg commented Oct 17, 2022

We can ignore the test failures, they're unrelated. I'll look into them if I have time or someone reports them explicitly. It's some oddity with shell scripting in the verify-everything-has-changed-properly CI setup.

@JoshuaKGoldberg JoshuaKGoldberg merged commit d60848d into LearningTypeScript:main Oct 17, 2022
@JoshuaKGoldberg
Copy link
Contributor

Separately, do you have a preferred avenue for typos in the text of the book itself? I found a small one but didn't see a place to fix it.

Great! Yes, there is an errata & submissions section on the O'Reilly site: https://www.oreilly.com/catalog/errata.csp?isbn=0636920578000

@JoshuaKGoldberg
Copy link
Contributor

@all-contributors please add @xavdid for content

@allcontributors
Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @xavdid! 🎉

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.

None yet

2 participants