Merge pull request #72 from joaojesus81/add/readme-contributing-guide

add: readme and contributing guide

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contribuição
+
+Antes de mais, obrigado por considerares participar neste projeto.
+
+Neste documento encontram-se instruções detalhadas para que possas contribuir em conformidade com a estrutura e organização do projecto. Estas instruções não são para ser consideradas regras rígidas mas sim uma orientação generalizada do que esperamos quando alguém contribui, utiliza o bom senso quando estiveres a contribuir para o projecto.
+
+#### 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. [Como contribuir](#como-contribuir)
+5. [Guia de estilos](#guia-de-estilos)
+   - [Código](#código)
+   - [Issues](#issues)
+   - [Mensagens de commit](#mensagens-de-commit)
+
+## Código de conduta
+
+Ao participares neste projeto, esperamos que tenhas em consideração 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, e tem Node e NPM como dependências principais. As versões necessárias podem ser consultadas no [ReadMe](README).
+
+Para instalar as dependências executa o comando `npm install`.
+
+## Como contribuir
+
+- Encontra um issue que te sentes capaz de ajudar. Se for a primeira contribuição, issues marcados com `bom primeiro issue` são normalmente considerados bons para principiantes.
+- Faz `fork` deste repositório para a tua conta pessoal.
+- Depois podes utilizar o `git` para fazer um `clone` para a tua máquina pessoal.
+- Cria um novo branch `git checkout -b novo-nome-branch`.
+- Faz as modificações que achas necessárias.
+- Faz commit do teu código para a origem do teu `branch`.
+- Cria um `pull request` no github para que possa ser revisto pela equipa.
+- Se receberes comentários ajusta o teu código e faz novos commits.
+- Quando for aprovado, o teu código vai ser `merged` com o `branch` main.
+
+## 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.