-
Notifications
You must be signed in to change notification settings - Fork 29
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
Alf0nso
merged 3 commits into
devpt-org:main
from
joaojesus81:add/readme-contributing-guide
Oct 15, 2024
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
joaojesus81 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### 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: | ||
joaojesus81 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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). | ||
joaojesus81 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.