diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f6000549..dfdc0025 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,23 +9,29 @@ Neste guia vamos explicar como funcionam os processos para que você possa contr
Existem diversas formas de contribuir com o projeto:
- [📖 Contribua com o Diciotech](#-contribua-com-o-diciotech)
- - [⚒️ Instalando ambiente de desenvolvimento para contribuir](#️-instalando-ambiente-de-desenvolvimento-para-contribuir)
- [🤔 Como contribuir](#-como-contribuir)
- - [Adicionando um novo termo técnico no Diciotech](#adicionando-um-novo-termo-técnico-no-diciotech)
- - [Adicionando uma nova tag no Diciotech](#adicionando-uma-nova-tag-no-diciotech)
- - [Reportando bugs](#reportando-bugs)
- - [Indicando melhorias e pedindo funcionalidades](#indicando-melhorias-e-pedindo-funcionalidades)
- - [Discutindo as issues](#discutindo-as-issues)
- - [Fazendo pull requests](#fazendo-pull-requests)
- - [Outras formas de contribuir](#outras-formas-de-contribuir)
+ - [⚒️ Instalando ambiente de desenvolvimento para contribuir](#️-instalando-ambiente-de-desenvolvimento-para-contribuir)
+ - [1. **Escolha um Editor de Código**](#1-escolha-um-editor-de-código)
+ - [2. **Execute o Projeto**](#2-execute-o-projeto)
+ - [1. **Instale um pré-processador SASS**](#1-instale-um-pré-processador-sass)
+ - [2. **Compile seu SASS**](#2-compile-seu-sass)
+ - [Adicionando um novo termo técnico no Diciotech](#adicionando-um-novo-termo-técnico-no-diciotech)
+ - [Adicionando uma nova tag no Diciotech](#adicionando-uma-nova-tag-no-diciotech)
+ - [Reportando bugs](#reportando-bugs)
+ - [Indicando melhorias e pedindo funcionalidades](#indicando-melhorias-e-pedindo-funcionalidades)
+ - [Discutindo as issues](#discutindo-as-issues)
+ - [Fazendo pull requests](#fazendo-pull-requests)
+ - [Outras formas de contribuir](#outras-formas-de-contribuir)
## ⚒️ Instalando ambiente de desenvolvimento para contribuir
### 1. **Escolha um Editor de Código**
+
* **Recomendação:** Visual Studio Code (gratuito, open-source, amplamente utilizado)
* **Outras opções:** Sublime Text, Atom
### 2. **Execute o Projeto**
+
Para visualizar seu projeto, você pode abrir o arquivo `index.html` em um navegador. Se quiser usar um servidor local (opcional), você pode instalar uma extensão no seu editor ou usar ferramentas como o **Live Server** no Visual Studio Code.
@@ -35,24 +41,31 @@ Para visualizar seu projeto, você pode abrir o arquivo `index.html` em um naveg
Você pode utilizar o Github.Dev para efetuar as alterações em arquivos do tipo markdown para isso é só ir no repositório e apertar a tecla . (ponto)
-
+
:rotating_light: Para efetuar alterações visuais
Caso queira mexer na parte visual do Diciotech, você também vai precisar, antes de executar o projeto:
#### 1. **Instale um pré-processador SASS**
+
Para compilar SASS em CSS, você precisará de um compilador. Recomendo a leitura do https://sass-lang.com/guide/ 👀
+```bash
+npm install -g sass
+```
+
#### 2. **Compile seu SASS**
+
Para compilar seu SASS em CSS, abra o terminal na pasta do seu projeto e execute:
```bash
-sass scss/styles.scss css/styles.css --watch
+sass assets/sass/style.sass assets/css/style.css --watch
```
+
O `--watch` faz com que o SASS fique monitorando alterações no arquivo `.scss` e compile automaticamente.
-### Adicionando um novo termo técnico no Diciotech
+## Adicionando um novo termo técnico no Diciotech
Adicione mais conteúdo no Diciotech [abrindo um pull request](#fazendo-pull-requests) com o termo que deseja que esteja presente no site. Para adicionar um novo termo, você deve acessar o arquivo `assets/data/cards_pt-br.json` e inserir um novo item na lista, seguindo a seguinte estrutura:
@@ -91,7 +104,7 @@ Antes de abrir o pull request, algumas **boas práticas** devem ser seguidas par
- Tome a cuidado para que as tags atribuídas a um termo façam sentido com o mesmo.
-### Adicionando uma nova tag no Diciotech
+## Adicionando uma nova tag no Diciotech
Você pode contribuir com o projeto propondo uma nova tag e a apresentando, como sugestão, por meio de uma [issue](https://github.com/levxyca/diciotech/issues) para que se possa abrir uma discussão a respeito, para uma futura adição através de pull request. As tags disponíveis **sempre** vão estar presentes nessa documentação.
@@ -104,25 +117,23 @@ Tags disponíveis:
- `Design`;
- `Ferramenta`;
- `Framework`;
+- `Front-End`;
- `Front-end`;
- `Inteligência artificial`;
- `Mobile`;
- `Paradigma`;
- `Rede neural`;
-- `Versionamento`;
-- `Web3`;
-- `Cybersecurity`;
-- `Infraestrutura de Rede`.
+- `Segurança cibernética`;
+- `Versionamento`
Antes de criar uma issue e abrir um PR, todas as tags devem seguir algumas boas práticas:
-
- Todas as tags devem estar no singular;
- Atualmente, as tags são _case sensitivity_, então, por padrão, apenas a primeira letra da tag deve ser maiúscula. Exemplo: Back-end, Conceito, Paradigma;
- Para adicionar uma nova tag, primeiro deve criar uma issue e, caso as pessoas usuárias concordem, um pull request deve ser aberto, contendo a tag. A PR sendo aprovada, a nova tag poderá ser vinculada a um termo;
- As tags devem ser mais generalistas e categóricas, já que dispomos de um campo de pesquisa para uma busca mais específica e precisa. Exemplo de tags: Front-end, Design, Back-end.
-### Reportando bugs
+## Reportando bugs
Se encontraste um bug você pode reportá-lo usando a ferramenta de
[issues do GitHub](https://github.com/levxyca/diciotech/issues). Porém, antes de criar a issue com as informações sobre o bug, é importante fazer as seguintes verificações:
@@ -136,7 +147,7 @@ título da issue tente resumir da melhor forma o problema encontrado.
Se possível inclua imagens ou vídeos à descrição do bug para facilitar o processo de reprodução. Você também deve adicionar o label **bug** à issue.
-### Indicando melhorias e pedindo funcionalidades
+## Indicando melhorias e pedindo funcionalidades
Outra ótima forma de contribuir é indicando melhorias ao código do projeto e em como ele está estruturado ou pedindo funcionalidades novas. Se você tem qualquer ideia de como podemos melhorar alguma abordagem na solução de problemas, refatoração de código, melhoria em algum recurso ou qualquer outra coisa relacionada, siga estes passos:
@@ -145,13 +156,13 @@ Outra ótima forma de contribuir é indicando melhorias ao código do projeto e
Concluindo esses dois passos, você pode [criar uma nova issue](https://github.com/levxyca/diciotech/issues/new) descrevendo as melhorias e usando o label **feature**.
-### Discutindo as issues
+## Discutindo as issues
Antes de partirmos para o código em si é muito importante discutirmos com a comunidade como cada issue será abordada.
Issues que estão em processo de discussão devem receber o label **discussion**, indicando que aquela issue precisa de feedbacks da comunidade.
-### Fazendo pull requests
+## Fazendo pull requests
Antes de abrir o seu PR, faça um fork do projeto e trabalhe em cima de um branch diferente da `main`, implementando suas soluções. Para saber mais sobre pull requests e como eles funcionam, veja [este link](https://help.github.com/articles/about-pull-requests/).
@@ -161,7 +172,7 @@ Antes de abrir seu PR (pull request):
- Se atente para que tenha um issue aberta relacionada ao seu PR;
- Caso não tenha, crie uma seguindo o guia de contribuição.
-### Outras formas de contribuir
+## Outras formas de contribuir
Se você não trabalha com código mas quer ajudar o projeto, existe muitas outras formas de contribuir: