diff --git a/Diretrizes-para-a-implementação.md b/Diretrizes-para-a-implementação.md index 5a45b19..e1f2707 100644 --- a/Diretrizes-para-a-implementação.md +++ b/Diretrizes-para-a-implementação.md @@ -2,7 +2,8 @@ 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 -Boa práticas +### Boa práticas + * 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 @@ -15,16 +16,18 @@ Boa práticas - Rodar `./manage.py check` - Rodar testes -Usar os seguintes componentes: +### Componentes + * Bootstrap para templates (ter sempre dispositivos móveis e acessibilidade em mente) * [Django Vanilla Views](http://django-vanilla-views.org) para views (e function based views para os casos mais simples) * Urls semânticas * [django-crispy-forms](http://django-crispy-forms.readthedocs.org/en/latest/) para forms com diagramação com Bootstrap -A definir: +### A definir + * O que usar para API Rest. O Colab usou [django-tastypie](https://django-tastypie.readthedocs.org/en/latest/) * O que usar para fazer forms de busca mais facilmente. Testar [django-filter](http://django-filter.readthedocs.org/en/latest/index.html) -Idioma: +### Idioma * 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