Add CONTRIBUTING.md

Author: AryanJ-NYC

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+Thank you for your interest in contributing to the [React And TypeScript](https://www.reactandtypescript.dev/) unoffical documentation. I hope to team up with others to create the premier source of React and TypeScript documentation on the web.
+
+## Creating Issues
+
+If you find a React and TypeScript example that would be an addition to this React and TypeScript documentation, please create an issue.
+
+When creating an issue, please include:
+
+- **User Story** - why does the reader want this information?
+- **Acceptance Criteria** - what examples need to be described for the reader to understand how to use React and TypeScript in the context described?
+- **Notes** (optional) - what resources can be leveraged to get this documentation written more quickly? Also, any extra notes go here.
+
+## Creating Pull Requests
+
+1. Confirm an issue exists for the pull request you are about to make. If no issue exists, [please create one](#creating-issues).
+2. Fork this repository.
+3. Create a branch specific to the section you are working on or adding. Push your work to that branch. Focus your work on that fix or feature.
+   - [Use good commit messages](https://chris.beams.io/posts/git-commit/).
+   - Name the branch appropriately.
+4. Submit a pull request against the _master_ branch.

README.md

@@ -1,16 +1,16 @@
-# Description
+# React and TypeScript
 
-# Run Locally
+## Description
+
+I created [React And TypeScript](http://reactandtypescript.dev) as a way for me to learn React and TypeScript. I decided to share my notes online which is exactly what you're looking at here. I hope for this project to grow and be _THE_ default source for React and TypeScript documentation.
+
+## Run Locally
 
 In your terminal at the project root, run:
 
-1. `npm install`
-2. `npm start`
+1. `yarn`
+2. `yarn start`
 
-# Contributing
+## Contributing
 
-1. Fork this repository.
-2. Create a branch specific to the section you are working on or adding. Push your work to that branch. Focus your work on that fix or feature.
-   - [Use good commit messages](https://chris.beams.io/posts/git-commit/).
-   - Name the branch appropriately.
-3. Submit a pull request against the _master_ branch.
+Thank you for your interest in contributing to the [React And TypeScript](https://www.reactandtypescript.dev/) unoffical documentation. Please visit the [Contributing page](./CONTRIBUTING.md) to learn more about contributing to this project.

src/components/Seo.tsx

@@ -14,7 +14,7 @@ function SEO({ description, lang, meta, keywords, title }) {
         lang,
       }}
       title={title}
-      titleTemplate={`%s | React and Typescript`}
+      titleTemplate={`%s | React and TypeScript`}
       meta={[
         {
           name: `description`,

src/pages/index.mdx

@@ -11,14 +11,12 @@ import SEO from '../components/Seo';
 
 # Hi people
 
-Coming soon: React and TypeScript documentation!
-
-<MailingListForm />
-
 Visit the [GitHub repository](https://github.com/AryanJ-NYC/reactandtypescript.dev) to contribute!
 
 For questions that are not covered in the documentation or to chat about React + TypeScript, join our [Spectrum Chat](https://spectrum.chat/react-and-typescript).
 
 A special thank you to [@swyx](https://twitter.com/swyx) for starting the [React TypeScript cheatsheet](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet) and inspiring the existence of this website.
 
 Lastly, tweet me at [@AryanJabbari](https://twitter.com/AryanJabbari). Words of encouragement are always welcome!
+
+<MailingListForm />