Guia de contribuição do Kit de Ferramentas do FinOps

Bem-vindo ao kit de ferramentas FinOps. Como uma iniciativa de código aberto, nosso sucesso depende do esforço coletivo da comunidade. Suas contribuições desempenham um papel vital no aprimoramento e na expansão dos recursos do kit de ferramentas, tornando-o mais valioso e eficaz para todos.

Há várias maneiras de contribuir com o kit de ferramentas FinOps:

  • Trabalhe em bugs existentes: Você pode ajudar identificando e corrigindo os bugs existentes listados em nosso repositório.
  • Forneça sugestões para novos recursos ou melhorias: se você não se sentir confortável com a codificação, ainda poderá contribuir sugerindo novos recursos ou melhorias para nossas ferramentas.
  • Proponha uma nova ferramenta: Se você desenvolveu uma ferramenta relacionada ao FinOps e deseja que ela faça parte do kit de ferramentas FinOps, envie uma proposta para consideração.
  • Revisar solicitações de pull: as revisões de código são um aspecto crítico para manter a qualidade do código e garantir a confiabilidade e a funcionalidade do projeto. Ao revisar as PRs (solicitações de pull) existentes sugeridas pelos membros da comunidade, você pode contribuir significativamente para o sucesso do projeto sem necessariamente criar um novo código.
  • Responda a perguntas: Estar ativamente envolvido em responder a perguntas e fornecer assistência aos membros da comunidade é uma contribuição inestimável para o projeto.
  • Atualizar documentação: a documentação serve como um recurso crucial para usuários, desenvolvedores e colaboradores. Nós nos esforçamos para manter a documentação precisa, abrangente e atualizada. É essencial para o sucesso do kit de ferramentas.

Agradecemos seu interesse em contribuir com o kit de ferramentas FinOps!

Quer se manter conectado com a equipe? Junte-se à nossa sincronização semanal de colaboradores às quartas-feiras às 8:00 do Pacífico/ 16:00 UTC ou horas quinzenais de escritório às 8:30 do Pacífico / 16:30 UTC.


Trabalhe em erros existentes

Se você está ansioso para contribuir, mas não sabe por onde começar, um ótimo ponto de partida é revisar a lista de comentários existentes. Em seguida, identifique problemas que se alinham com suas habilidades e interesses.

  1. Examine a lista de problemas existentes.
  2. Atribua-se ao bug em que deseja trabalhar.

Se você estiver lendo este artigo pela primeira vez e estiver trabalhando no repositório do kit de ferramentas FinOps, certifique-se de revisar nosso wiki de introdução.


Formas de contribuição

O projeto do kit de ferramentas FinOps oferece várias maneiras de contribuir, seja você um desenvolvedor, um praticante de FinOps ou um entusiasta da nuvem. As seções a seguir abordam maneiras de se envolver.

Enviar um novo problema

Se você tiver uma sugestão de novo recurso, identificou um bug ou tem ideias para melhorar as ferramentas existentes, recomendamos que você envie um problema. Seus comentários nos ajudam a garantir que o kit de ferramentas atenda às necessidades de seus usuários. E se você estiver disposto a dar um passo adiante e contribuir para a implementação de suas sugestões, agradecemos suas contribuições.

Para fazer isso, siga estas etapas:

  1. Vá para a lista de problemas e selecione Novo problema.
  2. Escolha a opção que melhor descreve sua contribuição (correção de bug, solicitação de alteração ou solicitação de recurso).
  3. Selecione Disposto a corrigir na parte inferior da página.
  4. Envie seu problema.

Proponha uma nova ferramenta

Se você desenvolveu uma ferramenta relacionada ao FinOps e deseja que ela faça parte do kit de ferramentas FinOps, vá para a lista de problemas, selecione Novo problema e selecione a opção Propor uma nova ferramenta . Inclua o máximo de informações possível sobre sua ferramenta e como ela pode beneficiar a comunidade FinOps.

O conselho de administração do kit de ferramentas FinOps analisa sua proposta e entra em contato com você para uma discussão mais aprofundada.


Examinar os pull requests

Verifique a lista de pull requests abertas e forneça comentários construtivos sobre as alterações de código propostas pelos membros da comunidade. Certifique-se de que o código esteja de acordo com nossas diretrizes de codificação, esteja bem documentado e siga as práticas recomendadas.

Ofereça sugestões para melhorar a qualidade do código, como otimizar o desempenho, melhorar a legibilidade e resolver possíveis casos extremos ou bugs.

Para garantir que eles funcionem conforme o esperado, teste a funcionalidade das alterações de código propostas na PR. Envolve a execução de testes, a verificação de casos extremos e a verificação de efeitos colaterais não intencionais.

Quando possível, tente sugerir alterações de código usando Adicionar uma sugestão para simplificar o processo de revisão.

Captura de tela da opção Adicionar uma sugestão em revisões de solicitação de pull.


Responder a perguntas

Estar ativamente envolvido em responder a perguntas e fornecer assistência aos membros da comunidade é uma contribuição inestimável para o projeto.

  • Compartilhe conhecimento: utilize seu conhecimento e experiência para fornecer respostas úteis e informativas às perguntas levantadas pelos membros da comunidade. Ofereça explicações, exemplos e referências claras para apoiar suas respostas.
  • Ajudar a resolver problemas: Ajude os membros da comunidade a solucionar problemas técnicos ou resolver problemas de configuração que encontrarem ao usar o kit de ferramentas.

Documentação de atualização

  • Identifique áreas de melhoria: Revise a documentação existente para identificar quaisquer informações desatualizadas, imprecisões ou lacunas que precisem ser abordadas.
  • Melhore a clareza e a consistência: esclareça seções ambíguas, reorganize o conteúdo para melhor estrutura e garanta a consistência na terminologia, formatação e estilo em toda a documentação.
  • Atualizar conteúdo: atualize informações desatualizadas, adicione novo conteúdo para cobrir recursos ou alterações recentes e remova seções obsoletas que não são mais relevantes.

Obrigado!

Suas contribuições para o código aberto, grandes ou pequenas, tornam possíveis projetos como este. Obrigado por dedicar seu tempo para contribuir.


Código de Conduta Aberto da Microsoft

Este projeto adotou o Código de Conduta de Software Livre da Microsoft.

Para saber mais, confira as Perguntas frequentes sobre o Código de Conduta ou contate o opencode@microsoft.com caso tenha outras dúvidas ou comentários.