Eu sempre tenho falado por aqui e no podcast sobre o GitHub, é não por menos que este projeto tem me chamado tanto à atenção. Um dos recursos mais legais que vi é a possibilidade de incluir comentários sobre o código de terceiros.
Nos grandes projetos, comentar o código está virando mania. Veja por exemplo este caso no próprio Rails. Joshua Peek comitou (hmm… como se diz isto em bom português?) um patch no trunk do Rails onde ele incluiu um arquivo .empty em cada diretório vazio do Rails, para que o GIT mantenha aquele diretório.
Acontece que normalmente é criado um arquivo .gitignore para isto. Claro que o nome não faz diferença, mas virou um padrão. Algum tempo depois alguém comentou:
Depois disto várias pessoas começaram a opinar sobre o assunto até que dois dias depois Joshua mudou o nome dos arquivos para .gitignore, satisfazendo a comunidade.
É ou não é um recurso interessante?
09/10/2008
3 Comentários em "A força dos comentários no GitHub"
Acho que “fez commit de” fica de bom tamanho
No podcast vcs comentaram que com o github+lighthouse, era possível comentar sobre uma única linha de código, etc. Mas não consegui, e gostaria de uma ajuda para fazer o seguinte:
Neste arquivo:
http://github.com/rails/rails/tree/master/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
eu gostaria de sugerir a substituição da linha 123
name = “#{name.nil? ? “SQL” : name} (#{sprintf(”%f”, runtime)})”
pelo código abaixo:
name = “#{name.nil? ? “SQL” : name} (#{sprintf(”%0.2f ms”, runtime*1000)})”
A justificativa é que na grande maioria dos softwares, as querys rodam em menos de 1 segundo, a maioria até em menos de 1 milisegundo. Então ao invés de vc ter um log assim:
SQL (0.00046) e ter que ficar contando quantos zeros tem para saber qual a velocidade da query, já que 1 zero a mais ou a menos, faz a sql ser 10 vezes mais rápida ou mais lenta.
por algo assim:
SQL (0.46 ms)…
SQL (2.39 ms)…
O mesmo para o tempo de todos os outros logs, por exemplo o log de renderização, ao invés de:
0.00006
seria:
0.06 ms
Isto poderia até ser uma configuração do Rails, ou algo automático, se o tempo for maior que 1 segundo, ele exibir em segundos, senão em ms.
Você pode me ajudar à reportar este feature, antes que o Rails 2.1 seja lançado?
Neste caso Marcos o melhor é vc fazer um fork do Rails e realizar as alterações necessárias na sua máquina, criar testes para todas as alterações, criar um patch no lighthouse e depois agariar alguns votos para entrar no Rails.
Não é um processo rápido… mas é melhor… apenas comentar a linha não seria o suficiente. Acho…
Quanto ao problema de comentar, é que os comentários só são permitidos em cima de alterações e não do arquivo em si.
Deixe o seu comentário!