Biblioteca de estilo da família OKTO
O que é?
Extensão do Bootstrap 4 modificado para se parecer com o wireframe do Okto porém sem modificar suas marcações de HTML originais. Por se tratar de uma extensão, tudo disponível na documentação do Bootstrap 4 poderá ser usado normalmente no projeto, além dos novos comportamentos aqui adicionados.
Arquitetura
Estrutura
TODO
Build
A build do scss é realizado apenas com node através dos scripts
do package.json.
Documentação
A documentação é gerada pelo kss-node automaticamente a partir dos comentários dos arquivos .scss
.
Regras
- Todo componente deverá ser agnóstico de Javascript;
- Todo componente não deverá possuir regras de negócio;
- Todo componente deverá ter todos os seus comportamentos documentados;
Como contribuir?
Quero adicionar um novo componente:
- Crie uma branch com o nome do componente com todo o código e documentação do mesmo;
- Faça um merge request para a master no gitlab;
- Avise outro front-ender que utiliza a biblioteca para fazer o code-review do seu código e aceitar ou reprovar o commit seguindo as Regras do merge request;
Quero corrigir um bug ou modificar um comportamento
- Vá para branch dev
- Altere o código que desejar
- Faça um merge request para a master no gitlab;
- Avise outro front-ender que utiliza a biblioteca para fazer o code-review do seu código e aceitar ou reprovar o commit seguindo as Regras do merge request;
Regras do merge request
Antes de aceitar qualquer merge request verifique se ele está de acordo com as seguintes premissas:
- Verifique se a nomeclatura do componente está clara e condizente com o que ele se propõe;
- Verifique se o componente está usando váriaveis, mixins e functions corretamente;
- Verifique se o componente está devidamente documentado;
- Verifique como o componente se comporta em diferentes resoluções;