Pimp My Repository (SJC Lightning Talks Quarta Edição)

Slides da lightning talk "Pimp My Repository", ministrada no SJC Lightning Talks Quarta Edição em 2014, no ITA, prédio ELE/COMP, Auditório B.

Resumo: "Já tentou usar um projeto, biblioteca, framework, etc. e nem sabia por onde começar, quais as dependências e outras perguntas?

Que tal começar a fazer algo que realmente divulgue e ajude a vender a sua ideia, e que facilite alguém usar?

Essa talk mostrará alguns elementos e coisas que podem ser feitas para tornar seu projeto mais "amigável" ou atraente a antigos e novos usuários. Acredite um simples link ou um README bem estruturado faz toda a diferença.".

Transcript

1. Pimp My Repository SJC Lightning Talks Quarta Edição 8 de Junho de 2014
2. smallint about me - Desenvolvedor Web - Autor e Mantenedor do guia colaborativo “git-start: Guia básico de Git” - Bolsista no INPE
3. O que esperar •  Basicamente são algumas percepções das minhas “andanças” pela internet –  Ou seja, nada do que será mostrado aqui é a verdade absoluta
4. Tenha um README •  E tenha um README explicativo!!! –  Muito do projeto pode ser explicado no README •  Não precisa ser uma documentação completa –  Mas não custa nada ensinar o básico para usar né?
5. Informe as dependências •  Se você está usando algo que não é da própria linguagem informe o nome e a versão !!!!! –  Nada mais infernal (e deselegante) que ficar caçando dependências e suas versões
7. Informe as dependências •  Algumas ferramentas obrigam a ter um arquivo descrevendo as dependências e suas versões –  Exemplos: NPM, Bower (Node.js), Composer (PHP), Gem (Ruby)
8. Escolha uma licença •  Parece bobeira, mas é algo que pode impedir a utilização de um projeto –  Se o seu projeto não tem uma licença ele é só seu •  Para auxiliar na escolha: choosealicense.com
9. Deixe um link visível •  Se o seu projeto tem um site ou possui demonstrações não faça o usuário procurar –  Ou ao menos não o faça procurar muito (=P)
10. GIFs….GIFs EVERYWHERE •  Se possível coloque um GIF demonstrando a utilização –  Não é obrigatório, mas é bem legal ver funcionando sem ter que instalar
12. Aprenda Markdown •  Markdown é uma linguagem de marcação aceita por diversos sites usados por programadores –  GitHub, Bitbucket, StackOverflow, Coderwall, entre muitos outros •  HTML é fácil de escrever, mas é ainda mais fácil de escrever Markdown (\o/)
13. “Modelo” do meu README # Nome do Projeto Descrição curta (1 linha) ## Infos * Feito no S.O.: * Testado nos S.O.s: * Linguagen Usada: * Dependências: * Licença:
14. “Modelo” do meu README ## Motivação Opcional ## Como ### Instalar ### Usar ## Referências * [Muitos links](http://stackoverflow.com)
15. TL;DR; •  Se você liberou sua idéia/projeto ao público deixe-a fácil de usar!! •  Aproveite os recursos de onde você hospeda –  O GitHub permite até a hospedagem de sites estáticos gratuitamente
16. Obrigado a todos!!! =D fadamiao fa_damiao smallintabout.me