Processos do lab (DRAFT PARA DISCUSSÃO)

Github

Qualquer membro do altLab pode usar o Github do lab para disponibilizar publicamente repositórios de código e documentação sobre projectos colectivos do lab (i.e. aqueles que estão disponíveis à colaboração dos restantes membros do lab e, eventualmente, do publico em geral)

Para aceder ao Github do lab devem criar uma conta no Github e pedir na mailing list para serem adicionados ao grupo.

Quando criarem um repositório recomenda-se os seguintes procedimentos:

  • escolher um idioma para os textos do repositório e usá-lo consistentemente. Para alargar o espectro de possíveis contribuições no Github, recomendamos o uso do inglês.
  • adicionar uma descrição clara do projecto e caso o mesmo não tenha uma página web, apontar para a sua página no documenta
  • activar os issues e desactivar o wiki
  • adicionar à raiz do repositório:
    • um ficheiro README com uma descrição do projecto, instruções de como o utilizar e um email de contacto
    • um ficheiro AUTHORS com a identificação de todas as pessoas que contribuiram para o projecto
    • um ficheiro LICENSE que indica qual a licença sob a qual os materiais do código são disponibilizados. Recomendamos as seguintes licenças

Workshops

Os workshops são a forma dos membros do lab (e outros convidados) partilharem o conhecimento que vão adquirindo com a comunidade. Para garantir o seu sucesso, recomendamos os seguintes procedimentos:

  • para workshops novos, fazer uma sessão de teste com os membros do lab antes de agendar o workshop.
  • comprar os materiais necessarios e divulgar o workshop com pelo menos um mês de antecedência.
  • criar uma página no documenta ou um repositório no Github que sirva de memória do evento. Esta página deverá ter:
    • uma breve descrição
    • uma imagem representativa
    • um registo da data e local das várias edições
    • um email de contacto (pode ser info@altlab.org)
    • links para materiais de apoio:
      • referências online ou bibliográficas
      • código fonte
      • esquemas electrónicos
      • ficheiros CAD