Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

99 lines (66 loc) · 4.68 KB

Contribuindo com o projeto!

Sumário

Pré-requisitos

  • Node: v14.15.1 ou superior.
  • yarn: 1.22.5 ou superior.

Começando

Clone o repositório do Gitlab:

$ git clone https://git.meifacil.com/meifacil-nodejs/libs/meifacil-common.git

Instale as dependências:

$ yarn

Testando o desenvolvimento local

Durante o desenvolvimento, é possível utilizar o pacote local nos projetos, através do comando yarn link.

Isso é extremamente útil para testar uma nova funcionalidade em um projeto já existente.

Para vincular a biblioteca à um projeto, siga os seguintes passos:

NOTA: Antes de iniciar o processo de vincular a biblioteca, tenha certeza que você executou o comando yarn build para gerar uma nova distribuição.

  1. Crie o link simbólico em meifacil-common/<ROOT>:
$ yarn link
docs/assets/yarn-link.gif
  1. Faça o link no projeto que deseja experimentar os recursos desenvolvidos:
$ yarn link meifacil-common
docs/assets/yarn-link-meifacil-common.gif

Veja mais em: https://classic.yarnpkg.com/en/docs/cli/link/

Escrevendo as mensagens do commit

As mensagens de confirmação devem seguir a especificação Conventional Commits, portanto, o CHANGELOG.md pode ser gerado automaticamente por ela. Se você não está familiarizado com a convenção de mensagem de commits, você pode usar yarn commit em vez de git commit, que fornece uma CLI interativa para gerar mensagens de commit adequadas.

Certifique-se de que os commits sejam escritos em inglês (não tem problema usar o Google Translate!), isso é apenas por conta da padronização utilizada.

Criando um Merge Request

Por aqui nada novo, porém (apenas para conhecimento), utilizamos feature branchs como convenção.

Se adicionar um novo recurso

Forneça um motivo convincente para adicionar esse recurso. Idealmente, você deve abrir uma issue de sugestão primeiro e então receber um "sinal verde" antes de trabalhar nela.

Colaboradores ✨


William Queiroz

💻 📖

Diogo Cezar Teixeira Batista

💻

Renan Braga Costa

💻

Lincon Santos

💻

Esse projeto segue a especificação all-contributors. Colabs de todos são bem-vindos!