IDEjr / faisca-2023

Projeto Faísca

• Documentação React

• Guia rápido de comandos do git

• Primeira instalação

  • Instale o Node.js

  • Clone o repositório

  • Comandos no terminal do VSCode

    • npm i (comando pra instalar tudo o que o app precisa)

• Como rodar

  • Comandos no terminal do VSCode

    • npm start
    • abrir http://localhost:3000/

• Guia rápido de boas práticas do git

  • Modelo de issue

    • Titulo: Deve ser um resumo da issue

    • Descrição:

      • Detalhes: Descrição do que deve ser feito na tarefa, de forma que qualquer outro membro da equipe possa entender
      • Imagens: Para auxiliar na identificação do que deve ser feito
      • Links úteis: Referencias diversas sobre o que pode auxiliar na tarefa

    • Ao criar uma issue, um número é associado a mesma e gerado automaticamente, esse número serve como referência para branch

  • Exemplo de nome de branch:

    issue #10
    

  • Exemplo de nome de commit:

    Breve descrição do que foi feito #10
    

  • Modelo de pull request

    • Vão existir três tipos de modelo para o Merge Request:

      • Feature: Adicionar funcionalidades novas
      • Bugfix: Correção de bug
      • Enhancement: Melhorias no codigo

    • Quando escolher alguma delas, preenchar os dados necessários para cada tipo específico

    • Escolha algum outro membro como corretor