Skip to content

Commit

Permalink
add contributing.md (#174)
Browse files Browse the repository at this point in the history
Create first version of contributing document in pt-br
  • Loading branch information
ocodista authored Nov 10, 2023
1 parent 78d58d7 commit ea2595f
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Como Contribuir para o Trampar de Casa

## Bem-vindo!

Agradecemos seu interesse em contribuir para o Trampar de Casa! Estamos abertos a diversos tipos de contribuições, incluindo código, documentação, design gráfico, testes unitários, práticas de DevOps, análise de dados e muito mais. Cada contribuição ajuda a tornar o Trampar de Casa um projeto mais forte e inclusivo.

## Tipos de Contribuições

Você pode contribuir de várias maneiras:

- **Código:** Seja adicionando novas funcionalidades, corrigindo bugs ou melhorando a performance.
- **Documentação:** Ajude a manter nossa documentação atualizada e acessível.
- **Design Gráfico:** Contribua com a criação de designs para a interface do usuário, logotipos e outros elementos visuais.
- **Testes Unitários:** Escreva e mantenha testes unitários para garantir a qualidade e a confiabilidade do código.
- **DevOps:** Auxilie na otimização de processos e ferramentas de DevOps.
- **Análise de Dados:** Contribua com insights a partir de análises de dados.

## Como Colaborar

1. **Faça um Fork do Projeto:** Comece fazendo um fork do repositório no GitHub.
2. **Modifique o Projeto:** Trabalhe em suas modificações no seu fork.
3. **Abra um Pull Request:** Após concluir suas alterações, abra um Pull Request para integrar suas modificações ao projeto principal.

## Pré-Formatando o Código

Utilizamos o lint-staged para pré-formatar o código antes de enviá-lo para o repositório. Certifique-se de seguir nossas diretrizes de estilo de código para manter a consistência.

## Comunicação

- **Issues no GitHub:** Para perguntas, sugestões, ou discussões sobre as contribuições, por favor, use o canal de issues no GitHub. É uma ótima maneira de se conectar com outros colaboradores e com a equipe do projeto.

## Código de Conduta

Lembramos a todos que é esperado seguir nosso Código de Conduta. É essencial manter um ambiente colaborativo e respeitoso.

## Agradecimentos

Suas contribuições são extremamente valiosas para nós. Cada contribuidor ajuda a tornar o Trampar de Casa um projeto melhor. Agradecemos seu tempo e esforço dedicados ao projeto!

0 comments on commit ea2595f

Please sign in to comment.