Skip to content

add: readme and contributing guide #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contribuição

Antes de mais, agradecimentos por considerares participar neste projeto.

Neste documento podes encontrar uma série de linhas para contribuir neste projeto. Estas instruções não são para ser consideradas regras rígidas mas guias, esperamos que cada pessoa use bom senso em cada participação.

#### Tabela de conteúdo

1. [Código de conduta](#código-de-conduta)
2. [Arquitetura](#arquitetura)
3. [Linguagem e versões](#linguagem-e-versões)
4. [Guia de estilos](#guia-de-estilos)
- [Código](#código)
- [Issues](#issues)
- [Mensagens de commit](#mensagens-de-commit)

## Código de conduta

Para participar neste projeto, esperamos que cada indivíduo siga as seguintes regras:

- Respeito pelo próximo
- Uso de linguagem inclusiva e acolhedora
- Aceitação de crítica construtiva
- Foco no que é melhor para a comunidade

## Arquitetura

- Este projeto segue, na sua grande maioria, o estilo de _Domain-Driven Design_ (DDD). Para mais informação consulta o nosso documento sobre [Arquitetura](ARCHITECTURE)

## Linguagem e versões

- A linguagem utilizada é Typescript. Para instalar as dependências precisas de ter acesso a Node e NPM. A versão de Node necessária pode ser consultada no [ReadMe](README).

Para instalar as dependências executa o comando `npm install`.

## Guia de estilos

#### Código

- O código deve ser escrito seguindo o estilo já presente no repositório.

#### Issues

- **Utiliza um titulo claro e descritivo** no issue para identificar a sugestão.
- **Fornece uma descrição exaustiva da melhoria sugerida** usando o máximo detalhe possível.
- Se aplicável, descreve os passos para replicar o issue.

#### Mensagens de commit

- Inclui referência ao Issue em questão se aplicável.
Loading