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: linting onboarding guides #1324

Merged
merged 5 commits into from Dec 18, 2019
Merged

docs: linting onboarding guides #1324

merged 5 commits into from Dec 18, 2019

Conversation

@bradzacher
Copy link
Member

bradzacher commented Dec 11, 2019

Fixes #1298

It's too hard to onboard as a new user. There are too many docs written in huge readmes, spread across too many packages.

This creates a centralised, simple, package-agnostic guide for people to follow.

Also because there's a lot of text here, I added a markdown spellchecker (and ran it across the codebase). I figured this would also help prevent future minor spelling PRs that we gotten a number of. As much as it pained me to do it, I set it to en-us.

Changes:

  • Adds linting onboarding docs
  • Removes sections around the place which had some of this information
  • Adds links to these new docs
  • Adds a markdown spellchecker to help ensure nobody borks spelling.
    • fixes spelling all over the place
  • Adds a basic CONTRIBUTING.md which echos everything I've been telling people forever.
@typescript-eslint

This comment has been minimized.

Copy link

typescript-eslint bot commented Dec 11, 2019

Thanks for the PR, @bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@bradzacher bradzacher changed the title docs: onboarding guides docs: linting onboarding guides Dec 17, 2019
@bradzacher bradzacher force-pushed the onboarding-docs branch from 46c8b7f to 219b706 Dec 17, 2019
@bradzacher bradzacher marked this pull request as ready for review Dec 17, 2019
@bradzacher bradzacher force-pushed the onboarding-docs branch from 219b706 to 1544714 Dec 17, 2019
bradzacher added 5 commits Dec 11, 2019
@bradzacher bradzacher force-pushed the onboarding-docs branch from 1544714 to dcfbf61 Dec 17, 2019
@bradzacher bradzacher merged commit 3e06f0f into master Dec 18, 2019
7 checks passed
7 checks passed
Semantic Pull Request ready to be squashed
Details
codecov/patch Coverage not affected when comparing 4f735e8...dcfbf61
Details
codecov/project 93.94% remains the same compared to 4f735e8
Details
typescript-eslint.typescript-eslint Build #20191217.14 succeeded
Details
typescript-eslint.typescript-eslint (Primary code validation and tests) Primary code validation and tests succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_10_x) Run unit tests on other Node.js versions node_10_x succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_8_x) Run unit tests on other Node.js versions node_8_x succeeded
Details
@bradzacher bradzacher deleted the onboarding-docs branch Dec 18, 2019
@armano2

This comment has been minimized.

Copy link
Member

armano2 commented Dec 18, 2019

small note, i think you missed updating README.md with link to CONTRIBUTING.md

Contributing Guide
COMING SOON
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.