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

Política de Branches

Na estrutura do projeto, estão travadas para push as branches main e develop, tendo em vista que são as branches que representam versões mais estáveis do projeto. Em nenhuma circunstância deve-se realizar pushes diretamente na branch main, e apenas em caso de hotfixes será permitido pelos administradores do repositório que pushes sejam feitos para a branch develop.

A branch gh-pages existe apenas no repositório de documentação e não deve ser utililzada pelos desenvolvedores.

Branches principais

  • main: Versão estável do projeto
  • develop: Ambiente de homologação do projeto (versões mais recentes e novas funcionalidades serão testadas aqui antes de serem integradas à main)
  • gh-pages: Branch existente apenas no repositório de documentação, de onde é gerada esta wiki.

Branches de trabalho:

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

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

  • hotfix/#<issue>-nome-da-issue
    Usada para corrigir bugs em produção rapidamente.
    Exemplo: hotfix/#1-correcao-login

  • feature/#<issue>-nome-da-issue
    Para desenvolver novas funcionalidades.
    Exemplo: feature/#2-cadastro-usuarios

  • release/vX.Y.Z
    Usada para preparar uma nova versão do projeto.
    Exemplo: release/v1.2.0

Para visualizar as branches que constam atualmente no projeto, consulte nossa Estrutura de Branches

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 seguindo o passo a passo sobre criação de issues
  4. Submeta suas alterações via Pull Request, seguindo o template disponível.

Referências

Adaptado do guia Over26