ifpeopensource / alvinator Goto Github PK

Muito código com indentação errada e comentários desnecessários.

Os arquivos .js na pasta "js" estão em sua maioria não otimizados e com muitos comentários desnecessários.

Já na pasta mathFunctions, os comentários não estão padronizados e a indentação está errada.

Para resolver esta issue:

• Otimizar, refatorar e padronizar os comentários dos arquivos na pasta "js"
• Padronizar indentação e comentários na pasta "mathFunctions"

Atualmente todas as folhas de estilo estão escritas em SASS.

Para facilitar a aquisição de contribuintes e diminuir a barreira de entrada de quem estiver disposto a contribuir, é bom utilizar apenas CSS.

Basta converter tudo que está no arquivo .scss num novo arquivo .css

Some error messages may appear on the results block, wich is not very efficient. Solving this issue can be done changing the messages on mathFunctions folder and adjusting it on decision.js

The CSS layout works just fine on desktop, but not that good on mobile devices. Solving this issue can be done adjusting and adding some CSS into the scss folder (remember to use Sass).

As docs estão muito simples, resolver esta issue é deixar elas mais amigáveis e intuitivas aos futuros contribuidores.
Caso queira trabalhar nesta issue, por favor sinalize nos comentários

O arquivo HTML possui muitas coisas desnecessárias, entre elas:

• Comentários
• Google Analytics tags
  etc...

Resolva esta issue modernizando o arquivo index.html

O objetivo principal no momento é o Alvinator 2.0!

Atualmente, o projeto está com arquitetura relativamente confusa e muito código mal feito.
O objetivo do Alvinator 2.0 será facilitar a implementação de novas funcionalidades dentro do site (por exemplo, inserir outros assuntos que não só de trigonometria, mas que seriam de grande ajuda para os estudantes).
Dessa forma, caso um estudante quisesse criar uma nova seção no site com novas equações e automatizações implementadas, poderia fazer isso de forma muito mais fácil e encapsulada, sem precisar modificar diretamente os arquivos principais.

A facilidade em criar novas funcionalidades ajudará na criação da comunidade: não só dos estudantes do IFPE que vão utilizar o site, mas principalmente dos que estiverem dispostos a contribuir!

Antes de nos concentrarmos no Alvinator 2.0, algumas tarefas precisam ser concluídas (não se preocupe, logo mais estarão todas listadas e diluídas em issues):

• Refatorar e modernizar todo o CSS, principalmente o mobile-friendly (isto envolve converter todo o SASS para CSS simples)
• Refatorar e modernizar todo o HTML
• Refatorar código JS (isto envolve por exemplo, limpar repetições desnecessárias, adicionar melhores comentários e otimizar operações)
• Renovar e reconstruir a arquitetura e estrutura de pastas (esta é uma tarefa mais ampla e longo prazo, visto que o código deverá ser abstraído e encapsulado, e, aos poucos, vamos estabelecendo padrões concretos)
• Facilitar a interação e a contribuição de qualquer público (isto envolve elaborar o README explicando o projeto, um guia de contribuição, código de conduta, a criação de issues, etc)
• À longo prazo, traduzir os READMEs, CONTRIBUTING, etc (embora o foco seja utilizar o português, à longo prazo a tradução dos documentos permitirá maior contribuição exterior)

Logo mais teremos mais novidades! Caso queira trabalhar em alguma destas tarefas, dá uma olhada nos nossos issues 😉

Acha que pode contribuir de alguma forma para o objetivo geral mas que não está descrita nos issues? Abra um issue e exponha suas ideias, teremos o prazer de conversar!

Some measures combinations are giving obviously wrong results. Fix fix fix

The cathetus values are swapped.

Steps to reproduce this error:

1. Choose b at the first input and insert a value.
2. Choose c at the second input and insert another value.