Skip to content

Diretrizes de contribuição

Este é o repositório principal centralizador do projeto EasyCrit.

Caso você esteja interessado em resolver um bug, ou adicionar uma nova feature, este repositório irá te guiar para a forma correta de contribuição.

O sistema de RPG virtual EasyCrit possui uma arquitetura de microsserviços, dividia em 4 repositórios de projeto. O repositório EasyCrit-frontend contém todo o projeto de desenvolvimento front-end do projeto, já o back-end está separado em 3 outros repositórios, sendo eles: EasyCrit-auth, EasyCrit-sessionManager e EasyCrit-fileManager. Cada um dos projetos de back-end possui seu próprio repositório e pode receber contribuições individuais. As issues devem ser mantidas apenas no repositório de documentação, para que seja centralizado a organização e visualização das tarefas de desenvolvimento do projeto.

Para rodar o projeto basta executar os comandos listados abaixo, considerando que as ferramentas de desenvolvimento necessárias listadas aqui estejam devidamente instaladas em seu sistema.

docker compose up

Informações importantes antes de contribuir com o EasyCrit

Crie sua Issue

Crie um Pull Request

  1. Verifique se já existe uma issue relacionada às suas alterações nas Issues.
  2. Se não existir:
  3. Crie uma nova issue com:
    • Uma descrição clara da mudança proposta.
    • Um título autoexplicativo.
  4. Submeta suas alterações via Pull Request, seguindo nosso template.

Política de Commits

Mensagens de Commit

  • Devem estar em português.
  • Devem ser claras e objetivas.
  • Devem referenciar a issue relacionada:
git commit -m '#X mensagem do commit'

Onde X é o número da issue

Commits em Pareamento

Quando houver trabalho em par:

  1. Use git commit -s
  2. Na primeira linha: a descrição do commit.
  3. Na segunda linha, adicione a autoria do par assim:

Co-authored-by: Nome Do Par <email@dominio.com>

Política de Branches

Estrutura principal:

  • main: Código estável (ambiente de homologação)
  • gh-pages: Documentação do projeto

Branches de trabalho:

  • docs/nome_documento
    Para alterações exclusivas de documentação.
    Exemplo: docs/manual-usuario

  • devel
    Branch principal de integração de funcionalidades antes de irem para a release.

  • hotfix/#issue-descricao-aqui
    Usada para corrigir bugs em produção rapidamente.
    Exemplo: hotfix/#1-correcao-login

  • feature/#issue-descricao-aqui
    Para desenvolver novas funcionalidades.
    Exemplo: feature/#2-cadastro-usuarios

  • release/tag-versao
    Usada para preparar uma nova versão do projeto.
    Exemplo: release/v1.2.0

Para mais detalhes, consulte nossa Estrutura de Branches

Referências:

Adaptado do guia Over26