13 Home

SAPL: Sistema de Apoio ao Processo Legislativo

Esta página reúne informações úteis ao desenvolvimento atual do SAPL.

Para maiores informações sobre a versão corrente do sistema (2.5) visite a página do projeto na wiki do Interelgis

To install your development environment see Development Environment Setup

Diretrizes gerais para a implementação da versão 3.1

Reproduzir exatamente (ou o mais próximo possível) a funcionalidade existente. As melhorias serão feitas nas versões a partir da 3.2

Mensagens de commit no padrão 50/72 colunas começando com um verbo no infinitivo. Vide:
- http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
- http://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting
Todo código no padrão PEP8
- Apenas relaxamos E501 (linhas sem limite de tamanho) nos arquivos models.py, por enquanto.
Antes de git push:
- Rodar principalmente git pull --rebase. Em alguns casos apenas usar merge (lembre que git pull => merge).
(...Usar um ramo novo para cada feature significativo? ...Talvez)
Antes de git commit, sempre:
- Rodar ./manage.py check
- Rodar testes com py.test (Importante: É necessário que o usuário sapl tenha a permissão create database no postgres)

Escreva testes para toda a funcionalidade que implementar.
Mantenha a cobertura de testes próxima de 100%.
Para executar todos os testes, na raiz do repositório, com o virtualenv ativado, usar o comando py.test.
- Na primeira vez que rodar os testes use py.test --create-db. Depois disso pode usar simplesmente py.test.
Para executar os testes com cobertura usar o comando:

py.test --cov . --cov-report term --cov-report html && firefox htmlcov/index.html

Bootstrap para templates (ter sempre dispositivos móveis e acessibilidade em mente)
Urls semânticas
django-crispy-forms para forms com diagramação com Bootstrap

O que usar para API Rest. Provavelmente usaremnos o django-rest-framework. O Colab usou django-tastypie
O que usar para fazer forms de busca mais facilmente. Testar django-filter

Inglês (Avaliar se isso funcionará bem para a comunidade)
- Commits, comentários, identificadores (nomes de variáveis, classes, funções, etc) em inglês

Instalação do SAPL 3.1 com Docker

Configuração do Ambiente de Desenvolvimento

Ambientes de Produção Testados por colaboradores da comunidade GITEC

Tradução (internacionalização)

Documentação