Merge pull request #16 from appswefit/chore/dependencies

Chore/dependencies

CHANGELOG.md

@@ -6,16 +6,16 @@
 
 - 8d58412: Adicionada funcionalidade para criar um arquivo `.npmrc` com credenciais, com comandos e utilitários para gerenciar as credenciais
 
-  ## Feature
+  #### Feature
 
   Adicionada nova funcionalidade para criar um arquivo `.npmrc` com credenciais, incluindo comandos e utilitários para gerenciar as credenciais.
 
-  ## Docs
+  #### Docs
 
   Foram feitas melhorias nos imports, adicionando central de exports dos comandos.
   Acrescentado também toggle para as documentações de cada comando.
 
-  ## Chore
+  #### Chore
 
   Atualizadas as bibliotecas para remover warnings de auditoria.
 
@@ -26,6 +26,6 @@
 - 11b6e79: Adicionado changeset para controle de versões do projeto
   Alterado a documentação do File ID do Figma para o novo padrão
 
-  ## Fix:
+  #### Fix:
 
   Corrigido erro ao gerar ícones por requisição com parâmetros muito grande.

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+## Introdução
+
+Obrigado por se interessar em contribuir com a CLI da WeFit 🤎. O apoio de nossos TechDesigners é fundamental para a manutenção e continuidade desse projeto, que visa facilitar nosso dia a dia.
+
+Nós aceitamos todo tipo de contribuição, não apenas código. Você pode contribuir com:
+
+- **Apontamento de BUGs**: Ao utilizar a CLI e perceber comportamentos inesperados você pode reportar isso nas *issues* desse repositório.
+
+- **Documentação**: Ajude-nos a melhorar a documentação das funcionalidades disponíveis.
+
+- **Novas funcionalidades**: Como dito anteriormente, o objetivo desta ferramenta é facilitar o dia a dia dentro da WeFit. Se você vê uma funcionalidade que poderia ser adicionada para ajudar nesse objetivo, fique a vontade para abrir uma *Pull Request* com novas implementações, ou caso não saiba ao certo como "codar" essa funcionalidade, você pode abrir uma issue sugerindo essa funcionalidade com as labels ***enhancement*** e  ***need help***
+
+- **Refatorações**: Fique a vontade para submeter melhorias na base de código.
+
+## Como contribuir com a base de código
+
+Todas as alterações na base de código deste repositório é realizada através da abertura de *pull requests* seguindo este fluxo:
+#### 1 - Crie uma cópia local do repositório
+
+```bash
+git clone https://github.com/appswefit/wefit-cli.git
+cd wefit-cli
+```
+
+#### 2 - Crie uma nova branch
+
+```bash
+git checkout -b feature/awesome-new-feature
+```
+
+#### 3 - Faça o push das mudanças para o github
+
+```bash
+git push origin feature/awesome-new-feature
+```
+
+#### 4 - Abra a Pull Request
+Na própria interface do github ou através da CLI do próprio github, realize a abertura da pull request, apontando para a branch `main`
+
+## Controle de Alterações com Changeset
+
+Ao realizar alterações neste projeto, é necessário atualizar o arquivo `CHANGELOG.md` para isso utilize o comando
+
+```bash
+  npm run changeset
+```
+
+Este comando irá criar um arquivo dentro da pasta `.changeset` na raiz do projeto, neste arquivo devem ser listadas todas as alterações realizadas, e ao final deve ser executado o comando.
+
+```bash
+  npm run version-packages
+```
+
+Com esse comando a versão do projeto e o arquivo `CHANGELOG.md` são atualizados.

Readme.md

@@ -178,41 +178,29 @@ we
 
 ---
 
-## Controle de Alterações com Changeset
-
-Ao realizar alterações neste projeto, é necessário atualizar o arquivo `CHANGELOG.md` para isso utilize o comando
-
-```bash
-  npm run changeset
-```
-
-Este comando irá criar um arquivo dentro da pasta `.changeset` na raiz do projeto, neste arquivo devem ser listadas todas as alterações realizadas, e ao final deve ser executado o comando.
-
-```bash
-  npm run version-packages
-```
-
-Com esse comando a versão do projeto e o arquivo `CHANGELOG.md` são atualizados.
-
----
-
 ## Templates
 
 Abaixo a lista de templates.
 
-- [Componente de ícone icon/config.json - React](./templates/Icon/)
+- [Componente de ícone para web - React](./templates/Icon/)
 
----
+- [Componente de ícone para mobile - React Native](./templates/mobile/)
 
-## Contribuidores
+## Como contribuir 🤝
 
 Agradecemos a todos que contribuíram para este projeto e tornaram a WeFit CLI ainda melhor!
 
-Para conhecer um pouco mais dos colaboradores, consulte abaixo:
+Para conhecer um pouco mais dos colaboradores, [consulte aqui](https://github.com/appswefit/wefit-cli/graphs/contributors)
 
-| [<img loading="lazy" title="Leonardo Fonseca" alt="Leonardo Fonseca" src="https://github.com/fonseca-leonardo.png" width="80"/>](https://github.com/fonseca-leonardo) | [<img loading="lazy" title="José Eduardo" alt="José Eduardo" src="https://github.com/jerp86.png" width="80"/>](https://github.com/jerp86) | [<img loading="lazy" title="Renan Bonassa" alt="Renan Bonassa" src="https://github.com/Bonassa.png" width="80"/>](https://github.com/Bonassa) | [<img loading="lazy" title="Mario Lima" alt="Mario Lima" src="https://github.com/limaCoder.png" width="80"/>](https://github.com/limaCoder) | [<img loading="lazy" title="João Luiz" alt="João Luiz" src="https://github.com/flammajl.png" width="80"/>](https://github.com/flammajl) | [<img loading="lazy" title="Vinícius Ponte" alt="Vinícius Ponte" src="https://github.com/ViniciusPonte.png" width="80"/>](https://github.com/ViniciusPonte) | [<img loading="lazy" title="Tiago Guimarães Pinto" alt="Tiago Guimarães Pinto" src="https://github.com/TiagoGP-exe.png" width="80"/>](https://github.com/TiagoGP-exe) |
-| --- | --- | --- | --- | --- | --- | --- |
+- [Veja como colaborar com esse projeto](./CONTRIBUTING.md)
 
-**Quer contribuir?**
+---
 
-Sinta-se à vontade para abrir um pull request! :)
+<p align="center">
+  <a href="https://wefit.com.br/">
+    <img width="75px" src="images/wefit-logo.jpeg">
+  </a>
+  <p align="center">
+    Construído e mantido pela <a href="https://wefit.com.br/">WeFit | Digital Service Design</a>.
+  </p>
+</p>