Skip to content

Commit 824ee98

Browse files
committed
write contributing file
1 parent b89388f commit 824ee98

File tree

2 files changed

+65
-3
lines changed

2 files changed

+65
-3
lines changed

CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
# Como Contribuir
3+
4+
Obrigado por se interessar em contribuir para este projeto! Queremos que todos possam participar, independentemente do seu nível de experiência. Aqui estão algumas orientações para ajudar você a começar.
5+
6+
## Passos Básicos
7+
8+
1. **Faça um Fork do Repositório**
9+
- No canto superior direito da página do repositório, clique em "Fork". Isso vai criar uma cópia do projeto na sua conta do GitHub.
10+
11+
2. **Clone o Projeto**
12+
- Agora que você tem uma cópia, clone o projeto para sua máquina local. Para fazer isso, use o comando:
13+
```bash
14+
git clone https://github.com/Douglas019BR/COWDOL.git
15+
```
16+
Isso baixa todos os arquivos do projeto para o seu computador.
17+
18+
3. **Crie uma Nova Ramificação (Branch)**
19+
- No diretório do projeto, crie uma nova branch. Vamos seguir o padrão: feat/fix/test - issue number / descrição. Caso não haja uma issue para você referenciar o que deseja fazer, crie uma, para que todos saibam que você está trabalhando nisso.
20+
```bash
21+
git checkout -b feat-02/improve-frontend
22+
```
23+
24+
4. **Faça as Mudanças**
25+
- Agora você pode começar a modificar o código ou os arquivos do projeto. Se não souber por onde começar, pode pedir ajuda para algum colaborador.
26+
27+
5. **Comite Suas Alterações**
28+
- Depois de fazer as mudanças, "comite" elas:
29+
```bash
30+
git add .
31+
git commit -m "Descrição clara da mudança"
32+
```
33+
34+
6. **Envie sua Ramificação (Branch)**
35+
- Envie suas alterações para o GitHub:
36+
```bash
37+
git push origin nome-da-sua-branch
38+
```
39+
40+
7. **Crie um Pull Request (PR)**
41+
- Volte ao repositório no GitHub, e você verá a opção de criar um "Pull Request" (PR). Clique e preencha os detalhes sobre o que você mudou e abra um PR para a branch __main__.
42+
43+
## Como Você Pode Ajudar?
44+
45+
Você pode contribuir de várias maneiras, incluindo:
46+
47+
- **Correções Simples**: Pequenas correções de bugs, melhorias de documentação ou correções de estilo de código.
48+
- **Novos Recursos**: Se você tem uma ideia para adicionar algo novo, abra uma **Issue** para discutirmos antes de começar.
49+
- **Relatório de Bugs**: Se você encontrou um bug, abra uma **Issue** descrevendo o problema e como reproduzi-lo. Não necessariamente você precisa resolvê-lo.
50+
51+
## Orientações Gerais
52+
53+
- **Seja Respeitoso**: Estamos aqui para aprender e construir juntos. Respeite as ideias e contribuições de todos.
54+
- **Peça Ajuda**: Se você não tem certeza de como fazer algo, não hesite em pedir ajuda nas **Issues** ou diretamente nos comentários do Pull Request.
55+
- **Documente Suas Mudanças**: Se sua contribuição muda algo importante no projeto, lembre-se de atualizar a documentação.
56+
57+
## Links Úteis
58+
59+
- [Como Fazer um Fork no GitHub](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
60+
- [Como Fazer um Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,12 @@ npm run start
4848

4949
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
5050

51-
### Contributing
52-
Contributions are welcome! Please feel free to submit a Pull Request.
51+
## Contributing
52+
53+
Thank you for your interest in contributing to this project! We welcome all contributions, regardless of experience level. Please refer to the [Contributing Guidelines](./CONTRIBUTING.md) for detailed instructions on how to get started.
54+
5355

5456
### Contact
55-
For any inquiries, please contact [[email protected]].
57+
For any inquiries, please contact [[email protected]] or another colaborator.
5658

5759

0 commit comments

Comments
 (0)