pythonclub.github.io
pythonclub.github.io copied to clipboard
pythonclub
Regras, "boas" praticas de publicação e organização (arquivos de publicação)
Ola pessoal, seria legal criar uma lista de "boas" praticas, regras de publicação e organização.
Segue algumas que acho pertinente.
Regras e boas praticas de publicação:
- Ao contribuir com artigos neste repositório, você concorda em licenciar seu artigo sob a licença XXXXXXXX.
- É terminantemente proibido divulgar qualquer tipo de conteúdo para coisas ilegais como por exemplo software pirata, livros piratas, cracks, keygens e etc.
- Independentemente da data em que o artigo foi planejado para ser publicado, a data contida na tag
:date:( reStructuredText) ou na tagDate:(Markdown), deve ser maior ou igual a data atual no Horário de Brasilia, e posterior ao horário da ultima publicação no site. Isso é necessário para evitar que os leitores do blog percam a referencial de ordem cronológica. - Proibido enviar videos diretamente para o github. Os videos deverão ser publicados no Youtube ou outro a definir.
- As Imagens utilizadas devem ser otimizadas no https://kraken.io com o intuito de diminuir o tamanho das mesmas. (algumas vezes a diminuição de tamanho chega a 80% sem perda visível de qualidade na imagem)
Organização (arquivos de publicação)
Sugiro que seja utilizando a seguinte forma para organizar os arquivos e diretórios:
content:
images:
nome_de_usuario_github:
arq_imagem.jpg
outra_arq_imagem.jpg
pdfs:
nome_de_usuario_github:
arq_pdf1.pdf
arq_pdf2.pdf
codigos_fonte:
nome_de_usuario_github:
arq_pdf1.py
arq_pdf2.js
arq_pdf3.c
publicacao_sobre_algo.md
outra_publicacao.md
mais_uma_publicacao.rst
Se houvesse alguma forma de organizar os artigos também seria ótimo.
Essa forma evitaria ter muitos arquivos espalhados no mesmo diretório e facilitaria achar o conteúdo para ser reutilizado ou referenciado em novas postagens, pois já estará organizado. Para mim, isso é necessário para evitar problemas num futuro, onde provavelmente teremos muitas publicações e muitos arquivos
Procurar escrever em norma culta, tentando evitar gírias ou termos muito técnicos.
Ser o mais claro possível em suas observações e dicas.
Revisar pelo menos uma vez o artigo para avaliar os pontos de vista e reformular ideias, caso seja necessário.
Concordo com a organização de imagens, sobre as datas e sobre não realizar upload de vídeos para o Github, mas a questão da escrita em forma culta acho desnecessário, a ideia é deixar o membro que está escrevendo a vontade para que ele possa fluir melhor a sua visão sobre o assunto, mas acho que ele realmente tem que tentar ser o mais claro possível.
No caso da revisão, acho que deveria ser feita além dele antes de enviar o que deve ser comum, ser feita também por quem for aceita o pull request, assim é menos provável um erro na publicação final.
abraços,
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
2014-05-12 13:31 GMT-03:00 Fábio C. Barrionuevo da Luz < [email protected]>:
Ei @dvl https://github.com/dvl @igr-santoshttps://github.com/igr-santos @henriquebastos https://github.com/henriquebastos mandem suas opiniões e ideias...
— Reply to this email directly or view it on GitHubhttps://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42855047 .
então tranquilo,
quer dizer palavras faltando letra, concordância incorreta e acentuação incorreta.
se for concordo então !
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
2014-05-12 15:59 GMT-03:00 Eric Hideki [email protected]:
Norma culta entenda se escrever corretamente. Nada rebuscado e tal.
— Reply to this email directly or view it on GitHubhttps://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42873244 .
Concordo com o @erichideki . Escrever em português respeitando-se minimamente a norma culta pelo menos a concordância, e terminantemente não escrevendo "internetes" e "girias".
eu sei, mas eu não quero é que o membro deixe de escrever por achar que não sabe escrever.
acho que essa parte de norma culta, o que foi citado, já é comum de alguém que vai escrever algo, talvez citar isso em algum local inibe a pessoa de contribuir, é isso que não queria que acontecesse.
mas acho que vai ser tranquilo, só elaborar melhor o texto, vai ser bem compreendido.
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
2014-05-12 16:12 GMT-03:00 Eric Hideki [email protected]:
Exatamente. O negócio é aberto, mas não quer dizer que seja bagunçado.
— Reply to this email directly or view it on GitHubhttps://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42874816 .
Entendo seu ponto de vista e concordo. A única observação no sentido de que não haja erros de grafia gritantes, de resto é tranquilo.
Claro que a cada artigo que a pessoa encaminhar podemos auxiliar com dicas e melhoras até para incrementar o texto como o aprendizado da pessoa.
Por mim, fechado então !
Podemos adicionar isso ao README.md também.
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
Em 12 de maio de 2014 16:34, Eric Hideki [email protected]:
Entendo seu ponto de vista e concordo. A única observação no sentido de que não haja erros de grafia gritantes, de resto é tranquilo.
Claro que a cada artigo que a pessoa encaminhar podemos auxiliar com dicas e melhoras até para incrementar o texto como o aprendizado da pessoa.
— Reply to this email directly or view it on GitHubhttps://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42877334 .
Na verdade o Github oferece um metodo especifico pra isso https://github.com/blog/1184-contributing-guidelines
We've tried making this easy for everyone. As a maintainer, all you have to do is add a CONTRIBUTING file (or CONTRIBUTING.md if you're using Markdown) to the root of your repository. Then we will add a link to your file when a contributor creates an Issue or opens a Pull Request.
Em 12 de maio de 2014 16:38, Igor dos Santos [email protected]:
Por mim, fechado então !
Podemos adicionar isso ao README.md também.
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
Em 12 de maio de 2014 16:34, Eric Hideki [email protected]:
Entendo seu ponto de vista e concordo. A única observação no sentido de que não haja erros de grafia gritantes, de resto é tranquilo.
Claro que a cada artigo que a pessoa encaminhar podemos auxiliar com dicas e melhoras até para incrementar o texto como o aprendizado da pessoa.
— Reply to this email directly or view it on GitHub< https://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42877334>
.
— Reply to this email directly or view it on GitHubhttps://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-42877899 .
Criei um arquivo para conter as regras de publicação e outras informações: https://github.com/pythonclub/pythonclub.github.io/blob/pelican/contributing.md
de acordo! fácil e objetivo.
Igor Santos Programador
+55 31 9117-7656 http://github.com/igr-santos
"...Simple is better than complex." (Guido van Rossum)
Em 5 de junho de 2014 10:30, Fábio C. Barrionuevo da Luz < [email protected]> escreveu:
Criei um arquivo para conter as regras de publicação e outras informações: https://github.com/pythonclub/pythonclub.github.io/blob/pelican/contributing.md
— Reply to this email directly or view it on GitHub https://github.com/pythonclub/pythonclub.github.io/issues/32#issuecomment-45218807 .