Skip to main content

So you want to contribute!

Thanks for helping out the community! We are actively looking for contributors and maintainers so you are more than welcome.

I thought I should lay out some core principles that we will follow so that this repo doesn't get too wild and lose its value.

  1. We are a CHEATSHEET above all: all examples to be as simple as possible, easily searched, and presented for copy-and-paste.
  2. Collapsible explanations: No more than 1-2 sentences of explanation, any more than that we put inside details tags.
  3. React + TypeScript ONLY: React's ecosystem is huge, we can't possibly cover it all. This includes Redux. Would encourage people to maintain separate lists for stuff like React + Apollo Graphql, for example. Also we make no attempt to convince people to use TypeScript, we only exist to help people who have already decided to try it out.
  4. Add TypeScript Playground Links: Whenever adding a code example longer than four lines, add a link to the TypeScript Playground with the code. Use the default compiler Playground options.

That's all I've got! Again, really happy you are thinking about helping out, who knows, the person who you might be helping is yourself in future!

Project structure

  • All content is in /docs
    • the /docs/basic is compiled into to preserve GitHub readability via GitHub action, thanks
  • /website consumes the /docs content, which is a Docusaurus 2 site, which also has Algolia search (thanks to both teams for their support!)

The website is deployed to Netlify on swyx's personal account.

To run the docsite locally:

yarn # install deps
## make sure deps are installed in /website too
cd website && yarn start

example output from successful startup

yarn run v1.22.4
warning package.json: No license field
$ docusaurus start
Starting the development server...

✔ Client
Compiled successfully in 9.61s

ℹ 「wds」: Project is running at http://localhost:3000/
ℹ 「wds」: webpack output is served from /
ℹ 「wds」: Content not from webpack is served from /Users/wanshawn/Work/react-typescript-cheatsheet/website
ℹ 「wds」: 404s will fallback to /index.html

✔ Client
Compiled successfully in 116.41ms