Workflow

Padrões do projeto

• Nome de pastas em minúsculo

  

• Nome de namespace em PascalCase (primeira letra maiúscula de cada palavra, tudo junto sem espaçamentos)

  • exemplo:

  <?php
  namespace Src\Repository;
  use Src\Model\Professor;
  use Src\Database\Database;

• Nomeclatura em inglês para classes, preferível para variáveis também.

• Variáveis e funções em camelCase (primeira letra minúscula da primeira palavra, as outras maíusculas)

  • exemplo:

  <?php
  namespace Src\Teste;
  
  $camelExample = "Dessa maneira";
  
  public function showCamel() : string {
      return $camelExample;
  }

Como fazer atualizações do projeto

• Recomendo que tenham baixado no VSCode a extensão Auto Open Markdown Preview (ele abre o README dentro do vscode ao abrir o arquivo)

1. Preparar o ambiente:

git init
git remote add origin https://github.com/DSM2SEM2024/-workflow.git
git config --local user.name "Seu nome"
git config --local user.email "Seu email DO GITHUB"

2. Baixar a ramificação (branch) principal, e criar uma nova ramificação

git pull origin main
git branch -m "prefixo/nome"

• feature/nome se for uma função/código
• docs/nome se for um documento
• fix/nome se for uma correção

Exemplo:

git branch -m feature/professor_repository
git branch -m docs/class_diagram
git branch -m fix/namespace

3. Após fazer suas alterações, tente puxar da branch main para garantir que está tudo em dia, então adicionar com um comentário e subir a sua branch :)

git pull origin main
git add *
git commit -m "Comentário do que você fez"
git push origin prefixo/nome

• Esse nome da branch tem que ser o mesmo que você definiu.

4. Crie um pull-request da branch que você criou depois de terminar tudo.

Isso você fará no próprio site do github, no repositorio da branch, no botão CONTRIBUTE e aguarde :D

• Me coloque como Reviewer (revisor) do Pull Request, e associe o Pull Request ao projeto Workflow conforme o print de exemplo (segunda imagem)