Skip to content

Latest commit

 

History

History
71 lines (41 loc) · 2 KB

File metadata and controls

71 lines (41 loc) · 2 KB

Contribuindo com o Seed++

Obrigado pelo interesse em contribuir com o Seed++!

Este projeto tem como objetivo servir tanto como um sistema funcional de controle de acesso quanto como um estudo de sistemas embarcados e paradigmas de programação aplicados ao hardware.

Como contribuir

Você pode contribuir de várias formas:

  • Melhorando o código do projeto
  • Corrigindo bugs
  • Melhorando a documentação
  • Sugerindo melhorias no sistema
  • Propondo novas funcionalidades

Processo de contribuição

  1. Faça um fork deste repositório.
  2. Crie uma nova branch para sua alteração.

Exemplo:

git checkout -b minha-melhoria
  1. Faça suas modificações no código.
  2. Realize commits claros e descritivos.
  3. Envie um Pull Request explicando o que foi alterado.

Hardware

Antes de propor mudanças no código, verifique se elas são compatíveis com os componentes listados no README do projeto.

Boas práticas

Ao contribuir com o projeto, procure:

  • manter o código organizado
  • comentar partes importantes do código
  • manter compatibilidade com o hardware utilizado no projeto
  • evitar mudanças que comprometam a estabilidade do sistema
  • não remover comentários importantes

Sugestões e problemas

Caso encontre algum problema ou tenha uma sugestão de melhoria, abra uma Issue descrevendo:

  • o problema encontrado
  • como reproduzir o erro
  • possíveis soluções (se houver)

Objetivo do projeto

Além de funcionar como um sistema de controle de acesso, o Seed++ também serve como material de estudo para futuros desenvolvedores da FnEsc interessados em sistemas embarcados e automação.

Toda contribuição que ajude a melhorar o projeto é bem-vinda.

Orientação para desenvolvedores da FnEsc

Caso alguma modificação seja realizada no Seed++, procure documentar as alterações neste repositório para facilitar o trabalho dos próximos desenvolvedores.

Mantenha sempre o repositório atualizado e compatível com o estado atual do projeto.