Contribuindo com o FreeBSD

Muitas pessoas envolvidas no FreeBSD não são programadoras. O Projeto inclui escritores de documentação, web designers e pessoas de suporte. Tudo o que essas pessoas precisam para contribuir é investir tempo e estar dispostas a aprender.

A maioria das tarefas listadas aqui pode exigir um investimento considerável de tempo, um conhecimento aprofundado do kernel do FreeBSD, ou ambos. No entanto, também existem muitas tarefas úteis que são adequadas para "hackers de fim de semana".

A lista de PRs do FreeBSD mostra todos os relatórios de problemas ativos e solicitações de aprimoramento que foram enviados pelos usuários do FreeBSD. O banco de dados de PRs inclui tarefas tanto para programadores quanto para não-programadores. Olhe através dos PRs abertos e veja se algo lhe interessa. Alguns desses podem ser tarefas muito simples que só precisam de um par extra de olhos para examiná-los e confirmar que a correção no PR é boa. Outros podem ser muito mais complexos, ou podem nem mesmo ter uma correção incluída.

Comece com os PRs que não foram atribuídos a mais ninguém. Se um PR foi atribuído a outra pessoa, mas parece algo que você pode lidar, envie um e-mail para a pessoa a quem foi atribuído e pergunte se você pode trabalhar nele - eles podem já ter um patch pronto para ser testado ou outras ideias que você possa discutir com eles.

A coleção de ports é um trabalho contínuo em andamento. Queremos fornecer aos nossos usuários um repositório de software de terceiros fácil de usar, atualizado e de alta qualidade. Precisamos que as pessoas doem parte de seu tempo e esforço para nos ajudar a alcançar esse objetivo.

Qualquer um pode se envolver e há muitas maneiras diferentes de fazer isso. Contribuir para os ports é uma excelente maneira de ajudar a "retribuir" algo ao projeto. Se você está procurando um papel contínuo ou um desafio divertido para um dia chuvoso, adoraríamos ter a sua ajuda!

Há várias maneiras fáceis de contribuir para manter a árvore de ports atualizada e em bom funcionamento:

A lista de projetos e ideias para voluntários do FreeBSD também está disponível para pessoas dispostas a contribuir para o projeto FreeBSD. A lista é atualizada regularmente e contém itens para programadores e não-programadores, com informações sobre cada projeto.

Uma ideia ou sugestão de interesse técnico geral deve ser enviada para a lista de discussão de assuntos técnicos relacionados ao FreeBSD. Da mesma forma, pessoas com interesse nesses assuntos (e tolerância para um volume alto de mensagens!) podem se inscrever na lista de discussão de assuntos técnicos relacionados ao FreeBSD. Consulte o Handbook do FreeBSD para obter mais informações sobre esta e outras listas de e-mail.

Se você está enviando um patch simples para o repositório src, considere enviar um pull request para o espelho do projeto no GitHub. Envios adequados devem:

Ao atualizar um pull request, por favor faça o rebase com um push forçado em vez de um commit de merge. Mudanças mais complexas podem ser submetidas como pull requests, mas podem ser fechadas se forem muito grandes, difíceis de manusear, tornarem-se inativas, precisarem de mais discussão na comunidade ou precisarem de uma revisão extensa. Por favor, evite criar grandes patches de limpeza abrangentes: eles são muito grandes e não têm o foco necessário para uma boa revisão. Patches mal direcionados podem ser redirecionados para um fórum mais apropriado para a resolução do patch.

Os pull requests submetidos ao repositório de ports podem ou não receber atenção, dependendo do interesse dos desenvolvedores. Por enquanto, para ter uma melhor experiência é melhor seguir o processo de submissão de ports descrito na seção Contribuindo com a coleção de ports .

A equipe de documentação também aceita pull requests via GitHub, mas ainda não estabeleceu nenhuma política para eles.

Se você encontrar um bug ou estiver enviando uma mudança específica, por favor relate-o usando o formulário de submissão de bug. Tente preencher cada campo do relatório de bug. A menos que excedam 65KB, inclua quaisquer patches diretamente no relatório. Se o patch for adequado para ser aplicado à árvore de código fonte, coloque [PATCH] na sinopse do relatório. Ao incluir patches, não use o copiar e colar, pois o copiar e colar transforma os tabs em espaços e os torna inutilizáveis. Quando os patches são muito maiores do que 20KB, considere comprimi-los (por exemplo, com gzip(1) ou bzip2(1)) antes de enviá-los.

Depois de enviar um relatório, você deve receber uma confirmação juntamente com um número de rastreamento. Guarde este número de rastreamento para que você possa nos atualizar com detalhes sobre o problema.

Veja também este artigo sobre como escrever bons relatórios de problemas.

As mudanças na documentação são supervisionadas pelo lista de discussão do projeto de documentação do FreeBSD. Por favor, consulte o FreeBSD Documentation Project Primer para obter instruções completas. Envie submissões e alterações (mesmo as pequenas são bem-vindas!) usando o mesmo método que qualquer outro relatório de bug.

Uma adição ou mudança no código-fonte existente é um assunto um pouco mais complicado e depende muito de quão desatualizado você está em relação ao estado atual do desenvolvimento do FreeBSD. Há uma versão especial em andamento do FreeBSD conhecida como "FreeBSD-CURRENT" que está disponível de várias maneiras para a conveniência de desenvolvedores que trabalham ativamente no sistema. Veja o Handbook do FreeBSD para mais informações sobre como obter e usar o FreeBSD-CURRENT.

Trabalhar a partir de fontes mais antigos infelizmente significa que suas alterações às vezes podem ser muito obsoletas ou divergentes demais para uma reintegração fácil no FreeBSD. As chances disso podem ser minimizadas um pouco ao se inscrever nas listas lista de distribuição de comunicados oficiais do projeto FreeBSD e lista de discussão do FreeBSD-CURRENT, onde ocorrem discussões sobre o estado atual do sistema.

Assumindo que você consegue obter fontes razoavelmente atualizadas para basear suas alterações, o próximo passo é produzir um conjunto de diffs para enviar aos mantenedores do FreeBSD. Isso é feito com o comando diff(1).

A preferência do formato diff(1) para envio de correções é o formato de saída unificada gerado pelo diff -u.

ou

Iria gerar um conjunto de diffs unificados para o arquivo ou hierarquia de diretórios de origem fornecidos.

Consulte diff(1) para obter mais informações.

Uma vez que você tem um conjunto de diffs (que você pode testar com o comando patch(1)), você deve enviá-los para inclusão no FreeBSD como um relatório de problema. Não envie apenas os diffs para a lista de discussão de assuntos técnicos relacionados ao FreeBSD, pois eles serão perdidos! Agradecemos muito sua contribuição (este é um projeto voluntário!); como estamos ocupados, pode ser que não consigamos lidar com isso imediatamente, mas ele permanecerá no banco de dados de PRs até que o façamos. Indique sua submissão incluindo [PATCH] no resumo do relatório.

Se você achar apropriado (por exemplo, você adicionou, removeu ou renomeou arquivos), agrupe suas alterações em um arquivo tar. Arquivos criados com o comando shar(1) também são bem-vindos.

Se a sua alteração for potencialmente sensível, como se você não tem certeza sobre questões de direitos autorais que regem a distribuição posterior, você deve enviá-la diretamente para core@FreeBSD.org em vez de enviar como um relatório de bug. O core@FreeBSD.org atinge um grupo muito menor de pessoas que fazem muito do trabalho diário no FreeBSD. Observe que esse grupo também é muito ocupado e, portanto, você só deve enviar e-mails a eles quando for realmente necessário.

Por favor, consulte intro(9) e style(9) para obter informações sobre o estilo de codificação. Agradecemos se você pelo menos estiver ciente dessas informações antes de enviar código.

No caso de uma contribuição significativa de um grande volume de trabalho, ou a adição de um novo recurso importante ao FreeBSD, torna-se quase sempre necessário enviar as alterações como arquivos tar ou carregá-los em um website ou FTP para que outras pessoas possam acessá-los. Se você não tem acesso a um website ou FTP, peça em uma lista de discussão apropriada do FreeBSD para alguém hospedar as alterações para você.

Quando se trabalha com grandes quantidades de código, a questão delicada de direitos autorais inevitavelmente surge. O FreeBSD prefere licenças de software livre tais como BSD ou ISC. Licenças copyleft como GPLv2 às vezes são permitidas. A lista completa pode ser encontrada na página da política de licenciamento do core team.

Estamos sempre muito felizes em receber doações para promover a causa do Projeto FreeBSD e, em um esforço voluntário como o nosso, um pouco pode fazer muita diferença! As doações de hardware também são muito importantes para expandir nossa lista de periféricos suportados, já que geralmente não temos fundos para comprar tais itens nós mesmos.

Esta seção lhe dará uma ideia do motivo pelo qual os ports precisam ser mantidos e esboçará as responsabilidades de um mantenedor de port.

Existem alguns bons lugares para encontrar um port que precisa de atenção.

Você pode usar a interface web do banco de dados de Relatórios de Problemas para pesquisar e visualizar relatórios de problemas não resolvidos. A maioria dos relatórios de problemas para os ports são atualizações, mas com uma pequena busca e leitura das sinopses você deverá ser capaz de encontrar algo interessante para trabalhar (a classe sw-bug é um bom lugar para começar).

O PortsFallout mostra problemas de ports coletados durante a compilação de pacotes no FreeBSD.

Também é OK enviar alterações para um port que possui um mantenedor, mas lembre-se de perguntar ao mantenedor no caso de já estarem trabalhando no problema.

Depois de encontrar um bug ou problema, colete informações, investigue e corrija! Se houver um PR existente, faça um follow-up nela. Caso contrário, crie um novo PR. Suas alterações serão revisadas e, se tudo estiver correto, serão comitadas.

À medida que seus interesses e compromissos mudam, você pode descobrir que não tem mais tempo para continuar com algumas (ou todas) as suas contribuições para a coleção de ports. Tudo bem! Por favor, nos avise se você não estiver mais usando um port ou se não tiver mais tempo ou interesse em ser um mantenedor. Desta forma, podemos seguir em frente e permitir que outras pessoas tentem trabalhar nos problemas existentes com o port sem termos que esperar por sua resposta. Lembre-se, o FreeBSD é um projeto voluntário, então se a manutenção de um port não for mais divertida, provavelmente é hora de deixar alguém fazer isso!

Em qualquer caso, a equipe de gerenciamento de ports (portmgr) se reserva o direito de redefinir sua posição de mantenedor se você não mantiver ativamente seu port por algum tempo. (Atualmente, este tempo é de 3 meses.) Com isso, queremos dizer que existem problemas não resolvidos ou atualizações pendentes que não foram trabalhadas durante esse tempo.

O Handbook do Mantenedor de Ports é o seu guia do sistema de ports. Mantenha-o sempre à mão!

o artigo Escrevendo Relatórios de Problemas do FreeBSD descreve como formular e submeter um PR da melhor maneira possível. Em 2005, mais de onze mil PRs de ports foram submetidos! Seguir este artigo ajudará muito a reduzir o tempo necessário para lidar com seus PRs.

O banco de dados de Relatórios de Problemas.

O scanner de arquivos de distribuição de ports do FreeBSD (portscout) pode mostrar os ports para os quais os arquivos de distribuição não podem ser baixados. Você pode verificar os seus próprios ports ou usá-lo para encontrar ports que precisam atualizar seus MASTER_SITES.

O ports-mgmt/poudriere é a maneira mais completa de testar um port por todo o ciclo de instalação, empacotamento e desinstalação. A documentação está localizada no repositório do GitHub do poudriere

O portlint(1) é um aplicativo que pode ser usado para verificar se o seu port está em conformidade com muitas diretrizes estilísticas e funcionais importantes. O portlint é uma aplicação heurística simples, portanto, você deve usá-lo apenas como guia. Se o portlint sugerir mudanças que parecem inaceitáveis, consulte o Porter’s Handbook ou peça conselhos.

A lista de discussão sobre a coleção de ports do FreeBSD é o local para discussões gerais relacionadas a ports. É um bom lugar para pedir ajuda. Você pode se inscrever, ou ler e pesquisar os arquivos da lista. Ler os arquivos das listas lista de discussão para relatar erros na coleção de ports do FreeBSD e mensagens de commit no repositório SVN para o head/ da árvore ports também pode ser interessante.

O PortsFallout é um site útil para buscar informações no arquivo de erros de pacotes do FreeBSD.