Skip to content

Commit d05a751

Browse files
updated CONTRIBUTING.md, made it better, precise, and emojified (#688)
* updated CONTRIBUTING.md, made it better, precise, and emojified * Format --------- Co-authored-by: Filip Tammergård <[email protected]> Co-authored-by: Filip Tammergård <[email protected]>
1 parent 40994aa commit d05a751

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

Diff for: CONTRIBUTING.md

+22-17
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
1-
# So you want to contribute!
1+
# Let's Contribute Together! 🚀
22

3-
Thanks for helping out the community! We are actively looking for contributors and maintainers so you are more than welcome.
3+
We appreciate your interest in contributing to this project. Here are some core principles and a simplified project structure to make your contribution process more efficient and effective:
44

5-
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.
5+
## 📋 Core Principles
66

7-
1. **We are a CHEATSHEET above all**: all examples to be as simple as possible, easily searched, and presented for copy-and-paste.
8-
2. **Collapsible explanations**: No more than 1-2 sentences of explanation, any more than that we put inside `details` tags.
9-
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.
10-
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.
7+
1. **We're All About Cheatsheets**: Our main goal is to provide concise and easy-to-use cheatsheets. All code examples should be simple, easily searchable, and ready for copy-and-paste.
118

12-
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!
9+
2. **Collapsible Explanations**: Keep explanations short and sweet, limited to 1-2 sentences. For more in-depth explanations, use `details` tags to provide additional context.
1310

14-
## Project structure
11+
3. **React + TypeScript Only**: We focus on React and TypeScript. React's ecosystem is vast, so we won't cover everything. If you think there's a need, consider maintaining separate lists for specialized topics, like React + Apollo GraphQL. We also don't aim to convince people to use TypeScript; we're here to assist those who have already chosen to use it.
1512

16-
- All content is in `/docs`
17-
- the `/docs/basic` is compiled into `README.md` to preserve GitHub readability via GitHub action, thanks
18-
- `/website` consumes the `/docs` content, which is a [Docusaurus 2](https://docusaurus.io/) site, which also has [Algolia search](https://www.algolia.com/) (thanks to both teams for their support!)
13+
4. **Add TypeScript Playground Links**: For code examples longer than four lines, include a link to the TypeScript Playground. Use the default TypeScript Playground options for the best experience.
1914

20-
The website is deployed to Netlify on swyx's personal account.
15+
Your contributions will help countless developers, including your future self! 🙌
2116

22-
To run the docsite locally:
17+
## 📁 Project Structure
18+
19+
- **Content in `/docs`**: All the content resides here.
20+
- The content in `/docs/basic` is compiled into `README.md` to ensure that it's easy to read on GitHub.
21+
- **`/website` Folder**: This part consumes the content in `/docs`. It's a Docusaurus 2 site and includes Algolia search. A big thanks to both the Docusaurus and Algolia teams for their support!
22+
23+
The website is deployed on Netlify, under swyx's personal account.
24+
25+
To run the docsite locally, follow these steps:
2326

2427
```bash
25-
yarn # install deps
26-
## make sure deps are installed in /website too
28+
yarn # Install dependencies
29+
## Ensure dependencies are also installed in /website
2730
cd website && yarn start
2831
```
2932

30-
example output from successful startup
33+
Here's an example of the expected output when the development server starts successfully:
3134

3235
```
3336
yarn run v1.22.4
@@ -46,3 +49,5 @@ Starting the development server...
4649
✔ Client
4750
Compiled successfully in 116.41ms
4851
```
52+
53+
Let's work together to enhance this resource and make it even more valuable to the developer community! 🌟👩‍💻👨‍💻

0 commit comments

Comments
 (0)