GGI Activity: Promover práticas recomendadas de desenvolvimento de código aberto

Table of contents

Promover práticas recomendadas de desenvolvimento de código aberto

ID da atividade: GGI-A-25.

Descrição

Esta atividade consiste em definir, promover ativamente e implementar as práticas recomendadas de código aberto no âmbito do equipas de desenvolvimento.

Como ponto de partida, os tópicos seguintes podem ser considerados à atenção:

  • Documentação do utilizador e programador.
  • Organização adequada do projeto num repositório acessível ao público.
  • Promover e implementar a reutilização controlada.
  • Fornecimento de uma documentação completa e actualizada do produto.
  • Gestão da configuração: fluxos de trabalho de git, padrões de colaboração.
  • Gestão de lançamento: lançamento cedo & lançamento frequente, versões estáveis versus versões de desenvolvimento, etc.

Projetos de OSS têm um modus operandi especial do tipo bazar. Para permitir e fomentar esta colaboração e mentalidade, práticas que facilitem o desenvolvimento colaborativo e descentralizado e as contribuições de desenvolvedores de terceiros são recomendadas…

Documentos comunitários

Assegure que todos os projetos na empresa proponham os documentos seguintes:

  • README – descrição rápida do projeto, como interagir, ligações a recursos.
  • Contribuir – introduções para pessoas dispostas a contribuir.
  • Código de Conduta – o que é aceitável – ou não – como se comportar na comunidade.
  • LICENSE – a licença padrão do repositório.

Práticas recomendadas do REUSE

REUSE é uma iniciativa da Free Software Foundation Europe para melhorar a reutilização de software e racionalizar o OSS e o cumprimento de licenças.

Avaliação de oportunidades

Embora dependa fortemente do conhecimento comum do OSS entre a equipa, a formação de pessoas e a criação de processos que imponham estas práticas é sempre benéfica. É ainda mais importante quando:

  • os utilizadores e contribuintes potenciais não são conhecidos,
  • os programadores não estão habituados ao desenvolvimento de código aberto.

Avaliação do progresso

Os seguintes pontos de verificação demonstram o progresso nesta atividade:

  • O projeto estabelece uma lista de práticas recomendadas de código aberto a cumprir.
  • O projeto monitoriza o seu alinhamento com as práticas recomendadas.
  • A equipa de desenvolvimento criou consciência sobre o cumprimento das práticas recomendadas do OSS.
  • As práticas recomendadas novas são avaliadas regularmente e um esforço é feito para as implementar.

Ferramentas

Recomendações

  • A lista das práticas recomendadas depende do contexto e do domínio do programa e deve ser reavaliada regularmente, para a melhorar continuamente. As práticas devem ser monitorizadas e avaliadas regularmente para rastrear o progresso.
  • Forme pessoas sobre a reutilização do OSS (como consumidores) e ecossistemas (como contribuintes).
  • Implemente o software REUSE.software como na atividade #14.
  • Estabeleça um processo para gerir os riscos legais associados à reutilização e às contribuições.
  • Incentive explicitamente as pessoas a contribuírem a projetos externos.
  • Forneça um modelo ou orientações oficiais para a estrutura do projeto.
  • Instaure verificações automatizadas para garantir que todos os projetos cumprem as diretrizes.

Recursos

Novas atividades propostas