Contribuindo para BeeWare Docs Tools¶

Existem várias maneiras de contribuir com BeeWare Docs Tools e com o BeeWare como um todo. Estes guias cobrem tudo o que você precisa saber para oferecer sua contribuição.

Posso contribuir?¶

Sim! Temos oportunidades de contribuição para pessoas de todos os níveis de experiência. Não importa se é a primeira vez que você contribui com código-fonte aberto ou se já o faz há anos, temos algo que funcionará para você.

É a primeira vez que você contribui para um projeto de código aberto? Estamos aqui para ajudar! Temos conselhos para colaboradores iniciantes para ajudar a superar quaisquer receios e preocupações iniciais.

Utilizando IA e ferramentas autônomas

O Projeto BeeWare não incentiva nem proíbe o uso de ferramentas de IA na realização de contribuições. No entanto, caso utilize uma ferramenta de IA, exigimos que declare quais ferramentas foram utilizadas. Nossa Política de IA contém todos os detalhes sobre suas obrigações.

O que posso fazer?¶

Corrigir um problema ¶

A contribuição mais óbvia que você pode fazer é escrever código para corrigir um problema conhecido.

Implementar um novo recurso ¶

BeeWare Docs Tools está faltando um recurso que você gostaria de ver? Você pode implementar um novo recurso.

Escrever documentação ¶

Nenhum recurso está completo até que esteja bem documentado. Escrever documentação é uma forma de contribuir que não envolve escrever código.

Triagem de um problema ¶

Toda vez que alguém relata um novo problema, esse problema precisa ser triado. A triagem de um problema envolve a coleta das informações fornecidas pelo relator e a tentativa de reproduzir o problema descrito.

Revisar um pull request ¶

Depois que uma pull request é enviada, ela precisa ser revisada antes de ser mesclada. Independentemente de você estar ou não profundamente familiarizado com o conteúdo, é provável que haja uma maneira de ajudar na revisão de uma pull request.

Sugerir um novo recurso ¶

Você tem uma sugestão ou ideia para uma nova adição a uma das ferramentas do BeeWare? Você pode propor um novo recurso para consideração.

Traduzir conteúdo ¶

O BeeWare mantém várias documentações em vários idiomas. Se você conhece um idioma diferente do inglês, pode ajudar com a tradução do conteúdo.

Use as ferramentas ¶

Você tem uma ideia para um aplicação desenvolvido com o Toga? Você tem um aplicação existente que poderia ser empacotado com o Briefcase? Você pode usar as ferramentas e fornecer feedback sobre sua experiência.

Como posso contribuir?¶

Configurar um ambiente de desenvolvimento ¶

Antes de começar a contribuir com o BeeWare, você precisará configurar seu ambiente de desenvolvimento.

Reproduzir um problema ¶

Antes de corrigir um problema, você precisará verificar se ele existe. Reproduzir um problema também é uma parte importante da triagem.

Trabalhar em uma filial ¶

Ao se preparar para enviar uma contribuição, sempre trabalhe a partir de uma ramificação.

Evite o aumento do escopo ¶

É importante manter o foco e evitar desvios de escopo com sua contribuição.

Proponha um novo recurso ¶

Você seguirá estas etapas para propor um novo recurso.

Escrever, executar e testar o código ¶

Para atualizar ou contribuir com o código, você precisará escrever, executar e testar seu código.

Documentação de construção ¶

Para atualizar ou contribuir com a documentação, você precisará ser capaz de criar os documentos.

Escrever documentação ¶

Para contribuir com a documentação, você escreverá novo conteúdo ou atualizará o conteúdo existente.

Adicionar uma nota de modificação ¶

Todo pull request deve ser acompanhado de uma nota de alteração.

Enviar um pull request ¶

Quando suas alterações estiverem prontas, você enviará um pull request para revisão.

Forneça uma avaliação ¶

Se você se sentir confortável, pode fazer uma avaliação da contribuição de outra pessoa.

Traduzir conteúdo ¶

O BeeWare usa o Weblate para traduções, o que requer algumas etapas para começar.

Enviar uma nova edição ¶

Se você se deparar com um novo problema ou bug, é útil enviar um problema.

O que acontece depois?¶

Revisão de pull request ¶

Quando um pull request é enviado, a próxima etapa é a revisão do PR.

O processo de liberação ¶

As contribuições mescladas passarão pelo processo de lançamento.

Políticas¶

Política de IA ¶

Política da BeeWare sobre o uso de IA generativa, grandes modelos de linguagem e outras ferramentas autônomas nas contribuições.

Guias de estilo¶

Código de estilo do guia ¶

Estas são as diretrizes para contribuir com código para os projetos do BeeWare.

Guia de estilo de documentação ¶

Estas são as diretrizes para contribuir com documentação para os projetos do BeeWare.