Skip to content
This repository has been archived by the owner on Jun 18, 2024. It is now read-only.

Latest commit

 

History

History
83 lines (57 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 3.18 KB
Raw

Contribuindo para o Projeto Faísca

Agradecemos por considerar contribuir para o projeto Faísca. Sua colaboração é fundamental para o crescimento e sucesso deste projeto. Aqui estão algumas diretrizes para ajudá-lo a se envolver de forma eficaz.

Identificando Commits e Tipos

Todos os commits tem um prefixo que identifica o tipo de alteração realizada no projeto.
Os prefixos servem como identificadores que ajudam a identificar as alterações realizadas no projeto e posteriormente saber o que foi feito logo de cara.

Prefixo Significado Exemplo de Mensagem no Commit
recurso Novos recursos 'recurso: Adiciona novo recurso'
fix* Correção de erros 'fix(#id): Arruma recurso'
typo Correção na digitação 'typo: Muda "exempol" para "exemplo"'
docs Documentação 'docs: Adiciona README.md'
tarefa Tarefas que não afetam o usuário final 'tarefa: Atualiza o CI do Vercel'
estilo Alterações no estilo do código 'estilo: Atualiza tabs para espaços'
refatora Mudanças no código otimização/leitura 'refatora: Atualiza função Update()'

Fix

Os commits de correção de erros são aqueles que corrigem erros críticos, como a falha na conexão da API, falha ao renderizar links dinâmicos, falhas de segurança etc. Todos os commits fix devem ter uma Issue associada.
Exemplo:

fix(#0): Arruma recurso

Neste exemplo temos um prefixo de commit fix(#0). O #0 é uma referência para a Issue com id de 0.

Como Contribuir

  1. Comece por clonar este repositório:
git clone https://github.com/SegundoInformatica/faisca-ui.git

ou

git clone git@github.com:SegundoInformatica/faisca-ui.git
  1. Crie uma branch para trabalhar nas suas alterações:
git checkout -b recurso/nome-recurso
  1. Realize as alterações:
git add .
git commit -m "prefixo: Mensagem" -m "Por que fazer isso?"
  1. Envie as alterações para o repositório:
git push -u origin recurso/nome-recurso
  1. Crie um Pull Request.

Diretrizes Gerais

  • Utilize um prefixo para identificar as alterações realizadas no projeto;
  • Mantenha o código limpo e siga as convenções de estilo do projeto;
  • (OPICIONAL) Crie uma Issue para cada alteração realizada;
  • No Pull Request, adicione um título descritivo que seja conciso e detalhado;
  • No Pull Request, adicione uma mensagem com as adições e modificações
  • Seja respeitoso e colaborativo com outros contribuidores;

Diretrizes de Estilo

Utilizamos a convenção de ESLint para identificar e corrigir problemas no código JavaScript. Juntamente, temos as configurações herdadas do ESlint Config Next.
Um simples Format nos arquivos *.{js,jsx,ts,tsx} irá formatar automaticamente o código.

Grupo Faísca © 2023-2024