Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 3.26 KB

Contribuindo para o Projeto Maloca das iCoisas

Obrigado por seu interesse em contribuir para o projeto Maloca das iCoisas! Este é um projeto focado na aplicação de IoT no contexto da saúde, utilizando placas como Arduino, Raspberry Pi e ESP32, programação em C e Python, e uma variedade de sensores e atuadores. Nossa comunidade acolhe entusiastas e especialistas de diversas áreas que queiram somar forças para melhorar este projeto.

Como Contribuir

  1. Faça o Fork do Repositório
    Crie um fork deste repositório para sua conta GitHub. Isso permite que você trabalhe em suas mudanças sem afetar o código principal.

  2. Clone o Repositório
    Clone o repositório para o seu ambiente local:

    git clone https://github.com/Maloca-iCoisas/maloca-turma-ufrr-2023.git
cd maloca-turma-ufrr-2023

  3. Configure um Branch de Desenvolvimento
    Crie um branch para a sua contribuição, indicando a área específica da melhoria. Por exemplo:

    git checkout -b melhoria-tutoriais-arduino-001

  4. Faça suas Mudanças e Testes
    Realize as modificações, e teste o código com os dispositivos necessários. Certifique-se de que sua contribuição:

    • Esteja bem documentada.
    • Siga as práticas recomendadas de programação em C e Python.
    • Tenha sido testada com os dispositivos aplicáveis (Arduino, Raspberry Pi, ESP32) e com os sensores/atuadores envolvidos.

  5. Comente seu Código
    Documente seu código com comentários claros. Descreva as principais seções e as variáveis relevantes, facilitando o entendimento para futuros contribuidores.

  6. Faça um Commit com Mensagens Descritivas
    Faça commit das suas mudanças com uma mensagem clara e descritiva. Utilize convenções de commit, como:

    git commit -m "Adiciona integração do sensor de temperatura com ESP32"

  7. Envie seu Branch para o Repositório
    Envie o branch com suas alterações para o GitHub:

    git push origin melhoria-tutoriais-arduino-001

  8. Abra um Pull Request (PR)
    Acesse o repositório original no GitHub e abra um Pull Request. No PR, descreva as mudanças feitas, incluindo a finalidade das alterações e quaisquer dispositivos ou bibliotecas específicas que foram usadas.

Padrões de Codificação

  • Linguagens: Utilize C para Arduino e ESP32, e Python para o Raspberry Pi.
  • Estrutura: Mantenha uma estrutura clara e organizada para os arquivos e pastas.
  • Bibliotecas: Ao utilizar bibliotecas externas, verifique se são bem documentadas e amplamente utilizadas na comunidade de IoT.

Revisão e Feedback

Após a submissão de um PR, a equipe do projeto fará uma revisão do código. Comentários podem ser feitos solicitando ajustes ou melhorias. Uma vez aprovado, seu código será mesclado ao repositório principal. Agradecemos sua paciência e colaboração!

Contato

Se tiver dúvidas sobre o processo de contribuição ou precisar de assistência com algum aspecto técnico, sinta-se à vontade para abrir uma Issue ou entrar em contato diretamente.

Obrigado por contribuir para o Maloca das iCoisas! Sua participação é fundamental para o desenvolvimento de soluções inovadoras para o setor de saúde através da IoT.