Skip to content

Commit b4d033f

Browse files
committed
docs: Added and translated the CONTRIBUTING.md file
1 parent 97da324 commit b4d033f

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Então você quer contribuir!
2+
3+
Obrigado por ajudar a comunidade! Nós estamos constantemente buscando por contribuidores e mantenedores então você é mais do que bem-vindo.
4+
5+
Eu pensei em estipular alguns princípios básicos que nós iremos seguir para evitar que este repositório se torne muito confuso e perca seu valor.
6+
7+
1. **Nós somos uma CHEATSHEET antes de tudo**: Todos os exemplos devem ser o mais simples possível, fáceis de encontrar, e apresentáveis para copiar-e-colar.
8+
2. **Explicações claras**: Nada além de 1 ou 2 sentenças de explicação, mais do que isso incluímos a tag `detalhes`.
9+
3. **SOMENTE React + TypeScript**: React possui um imenso ecossistema e é impossível cobri-lo completamente. Isto inclui Redux. Sugiro ás pessoas a manter listas separadas para coisas como React + Apollo Graphql, por exemplo. Nós também não tentamos convencer ninguém a usar TypeScript, estamos aqui para ajudar as pessoas que já decidiram experimentá-lo.
10+
4. **Inclua links para o sandbox do Typescript**: Sempre que adicionar um exemplo de código com mais de quatro linhas, adicione um link para o sandbox com o código em Typescript. Use as opções padrão do compilador.
11+
12+
E é isso! Outra vez, estamos muito felizes que você esteja pensando em ajudar e, quem sabe, a pessoa que você está ajudando pode ser você mesma no futuro!
13+
14+
## Estrutura do projeto
15+
16+
- O conteúdo completo está em `/docs`
17+
- O `/docs/basic` é compilado no `README.md` para preservar a legibilidade do GitHub por meio de GitHub actions, obrigado
18+
- `/website` consome o conteúdo de `/docs`, que é um site [Docusaurus 2](https://docusaurus.io/), que possui o sistema de [busca Algolia](https://www.algolia.com/) (obrigado a ambas as equipes pelo apoio!)
19+
20+
O site está hospedado no Netlify, na conta pessoal do swyx.
21+
22+
Para rodar o docsite localmente:
23+
24+
```bash
25+
yarn # instala as dependências
26+
## garanta que as dependências também sejam instaladas em /website
27+
cd website && yarn start
28+
```
29+
30+
exemplo de instalação bem-sucedida
31+
32+
```
33+
yarn run v1.22.4
34+
warning package.json: No license field
35+
$ docusaurus start
36+
Starting the development server...
37+
38+
✔ Client
39+
Compiled successfully in 9.61s
40+
41+
ℹ 「wds」: Project is running at http://localhost:3000/
42+
ℹ 「wds」: webpack output is served from /
43+
ℹ 「wds」: Content not from webpack is served from /Users/wanshawn/Work/react-typescript-cheatsheet/website
44+
ℹ 「wds」: 404s will fallback to /index.html
45+
46+
✔ Client
47+
Compiled successfully in 116.41ms
48+
```

0 commit comments

Comments
 (0)