Skip to content

Latest commit

 

History

History
212 lines (115 loc) · 4.75 KB

contributing.md

File metadata and controls

212 lines (115 loc) · 4.75 KB

Contributing

Se você deseja colaborar com o desenvolvimento do SmartSchool, siga os passos abaixo:

Criando sua conta no Github

O primeiro passo é criar uma conta no GitHub seguindo as instruções abaixo:

Clone do Repositório

Abra o terminal do Git Bash

  • Navegue até o diretório onde você deseja clonar o repositório, utilizando o comando:
  cd /c/Users/SeuUsuario/SeuDiretorio
  • Clone o repositório para o diretório navegado, utilizando o comando:
  git clone https://github.com/Manuelaamorim/SmartSchool.git

Após acessar no código

  • Habilitando execução de scripts no PowerShell do Windows:
  Set-ExecutionPolicy -Scope CurrentUser Unrestricted
  • Criando um ambiente virtual:
  py -m venv venv
  • Ativando o ambiente virtual:
  venv\Scripts\activate.bat
  • Instalar o conteúdo do requirements.txt:
  pip install -r requirements.txt
  • Criação de arquivos de migração baseados nas mudanças já existentes:
  python manage.py makemigrations appsmartschool
  • Aplicação das migrações ao seu banco de dados:
  python manage.py migrate

Por fim, quando necessário, realize os comandos a seguir:

  python manage.py runserver
  • Verificando o status do repositório:
  git status
  • Adicionando arquivos modificados:
  git add .
  • Fazendo o commit das mudanças:
  git commit -m “seu comentário”
  • Enviando as mudanças para o repositório remoto:
  git push
  • Recebendo atualizações do código:
  git pull

Requisitando permissão para commitar

Se você não foi adicionado como colaborador, siga estes passos para requisitar permissão para commit:

  • Solicitando acesso: Abra uma issue no repositório solicitando permissão para ser adicionado como colaborador. Descreva brevemente seu interesse em contribuir e as áreas específicas em que você gostaria de ajudar.

  • Aguardando aprovação: Um mantenedor do repositório revisará sua solicitação e, se aprovado, adicionará você como colaborador.

  • Confirmando colaboração: Após ser adicionado como colaborador, você receberá uma notificação por e-mail. Confirme a colaboração e siga os passos de envio de atualizações listados acima.

Criando contas nas ferramentas necessárias e acessando-as

Solicitação de merge da prod para a main

Para solicitar um merge da branch prod (que está na Azure) para a branch main, siga os passos abaixo:

  • Certifique-se de que está na branch prod:
  git checkout prod
  • Atualize a Branch prod:
  git pull origin prod

  • Crie um pull request: Crie um novo pull request no GitHub solicitando o merge da prod para a main. Inclua uma descrição detalhada das mudanças e qualquer contexto necessário para a revisão.

  • Aguarde revisão e aprovação: Notifique os mantenedores do repositório sobre o pull request para que possam revisar e aprovar as mudanças.

  • Merge aprovado: Após a aprovação, um mantenedor do repositório fará o merge das mudanças na branch main.

Seguindo esses passos, você garantirá que todas as mudanças sejam revisadas e integradas corretamente ao projeto.

Acessando nossa aplicação na Azure

  • Acesse o endereço https://fdssmartschool.azurewebsites.net/ para visitar a aplicação da Smartschool, siga as diretrizes de contribuição descritas no nosso repositório para manter a consistência e qualidade do projeto.

Observação: Antes de acessar a aplicação web da Smart School, lembre-se de verificar as issues abertas para garantir que sua colaboração seja o mais eficaz possível. Antes de iniciar, comente na issue em que você está interessado para que os outros colaboradores saibam que você está trabalhando nela.