DEV Community: Comp Júnior

Descrevendo e criando issues como um profissional

Gustavo — Thu, 17 Aug 2023 03:15:01 +0000

Domine a arte de criar descrições profissionais de problemas no GitHub! Este post revela como usar templates de issues para agilizar a documentação de bugs, incluindo elementos-chave como ambiente, comportamento esperado, passos para reproduzir e soluções.

Introdução
Descrevendo issues como um profissional
Utilizando templates para criar issues
Exemplo de template
Exemplos no mundo real

Introdução

Esse é o segundo post da série falando sobre issues e GitHub Projects. Já expliquei sobre as issues no primeiro post, recomendo que comece por ele.

Agora vou focar na descrição das issues e mostrar uma forma mais automatizada de criar issues.

Descrevendo issues como um profissional

Dados do Ambiente: Este é o contexto em que o problema ocorre. Pode incluir a versão do software, versão do sistema operacional, dependências relevantes e qualquer outra informação relevante.
Comportamento Esperado: O que você achava que o software faria ou deveria fazer.
Comportamento Real: O que o software está realmente fazendo. Aqui é onde você detalha o problema.
Passos para Reproduzir: Um guia passo a passo para recriar o problema.
Imagens/Capturas de Tela: Ajudas visuais para ilustrar o problema ou a sua ideia.
Registros de Erro: Os famosos logs, se disponíveis, podem fornecer informações valiosas sobre o problema.
Possível Solução/Sugestões: Ideias ou sugestões que possam ajudar a resolver o problema.

Utilizando templates para criar issues como um profissional

Agora que você já sabe como descrever as issues de forma profissional, é hora de dar um passo adiante e otimizar ainda mais o processo, tornando-o mais consistente e eficiente. Uma ótima maneira de fazer isso é utilizando templates para criar issues no GitHub.

Vantagens de usar templates de issues

Padronização: Os templates garantem que todas as issues sigam um formato consistente, o que facilita a compreensão por parte de todos os envolvidos no projeto.
Informações Relevantes: Com campos específicos para o ambiente, comportamento esperado, comportamento real e outros detalhes importantes, os templates ajudam a capturar as informações necessárias para uma análise eficiente do problema.
Economia de Tempo: Ao criar issues a partir de templates, você economiza tempo ao não precisar pensar repetidamente em quais informações incluir. Isso acelera o processo de documentação e resolução de problemas.

Como criar e usar templates de issues

Acesse as Configurações do Repositório: No GitHub, vá até o seu repositório e clique na aba "Settings".
Desça até a seção "Features" e clique em "Set up Templates"
Depois disso, você pode escolher o tipo de issue mais usuais: Bug, Feature. Ou você pode criar um template customizado para outro propósito em "Custom template"
Preencha o Template: Quando você cria uma nova issue, você terá a opção de escolher um template e preencher os campos correspondentes. Isso garante que todas as informações relevantes sejam inseridas de maneira organizada.
Quando terminar, não se esqueça de salvar as alterações ao clicar no botão "Propose Changes". Aparecerá uma tela para aplicar as alterações no repositório por meio de um commit, é só especificar a mensagem e fazer o commit clicando em "commit changes"!

Exemplo de template

## Descrição do Problema

[Descreva aqui o problema de maneira sucinta]

### Dados do Ambiente

- **Versão do Software:** [inserir versão]
- **Versão do Sistema Operacional:** [inserir versão]
- **Dependências Relevantes:** [listar dependências, se aplicável]

### Comportamento Esperado

[Descreva aqui o comportamento que era esperado]

### Comportamento Real

[Descreva aqui o comportamento observado]

### Passos para Reproduzir

1. [Descreva o primeiro passo]
2. [Descreva o segundo passo]
3. [E assim por diante...]

### Imagens/Capturas de Tela

[Insira imagens ou capturas de tela para ilustrar o problema]

### Registros de Erro

[Inclua logs ou mensagens de erro relevantes]

### Possível Solução/Sugestões

[Tenha espaço para ideias ou sugestões para resolver o problema]

Exemplos no mundo real

React

Issue de bugs:

FreeCodeCamp

Issue do freeCodeCamp para entregar desafios de código da plataforma

Conclusão

Dominar a arte de descrever issues de maneira profissional e aproveitar os templates do GitHub é fundamental para um gerenciamento eficiente de projetos. Essas práticas não apenas aprimoram a comunicação, mas também impulsionam a resolução de problemas de forma estruturada e colaborativa. À medida que você avança em sua jornada de desenvolvimento, lembre-se sempre de aplicar esses conhecimentos para alcançar resultados mais sólidos e produtivos!

A Comp Júnior!

A Comp Júnior é uma EJ (não sabe o que é? Então clique aqui) que atua no mercado de tecnologia há mais de 20 anos em Lavras e região, prestando serviço de desenvolvimento web, mobile e multiplataforma.

Nossa missão é oferecer a transformação digital aos nossos clientes, expandindo os seus negócios para o mercado digital e alcançando um potencial desconhecido.

Se você quer saber mais, acesse nosso site!
Ou, se preferir, acesse nosso Instagram!

Documentando o desenvolvimento com issues

Gustavo — Tue, 15 Aug 2023 18:58:01 +0000

Conteúdos

Introdução
O que é uma Issue
A anatomia de uma issue
Acompanhando uma issue
Conclusão
Links e referências

Introdução

Quero bater um papo sobre algo que está sempre presente no nosso dia a dia, mas nem sempre damos a devida atenção: o mundo do GitHub. Se você já passou pela situação de olhar para um código que fez há meses e se perguntar "O que diabos eu estava pensando aqui?", então, meu amigo, este post é para você!

Muitas vezes nos pegamos focados no ato de codar, implementar, criar, e esquecemos que a documentação é como a bússola que nos guia em meio ao caos do código. É aquele mapa detalhado que não apenas nos ajuda a lembrar o que fizemos quando voltamos para o projeto depois de um tempo, mas também permite que outros colegas de equipe se juntem e consigam contribuir sem ficarem completamente perdidos.

Disclaimer: Se você nunca ouviu falar de Git ou GitHub, recomendo fortemente que leia o Git4Noobs e pratique antes de continuar!

O que é uma Issue?

Em inglês, issue quer dizer problema, porém, utilizamos para diversas coisas além disso, como rastrear ideias, comentários, tarefas ou erros nos repositórios no GitHub.

Criando uma issue

Acesso ao Repositório: Primeiro, acesse o repositório no GitHub. Certifique-se de estar logado em sua conta.
Navegando para Issues: No menu superior do repositório, clique na guia "Issues". Aqui podemos visualizar todas as issues do repositório (por padrão, são mostradas as issues que ainda não foram resolvidas, fechadas):
Criando uma Nova Issue: Para criar uma nova issue, clique no botão verde "New Issue". Agora, você estará pronto para preencher os detalhes.

A anatomia de uma issue

Título: Um título conciso, porém descritivo, que resume o problema.
Etiquetas/Tags: Etiquetas ou tags aplicáveis para categorizar o problema, facilitando a ordenação e o gerenciamento.
Labels: As labels ajudam a categorizar e identificar o tipo de issue.
Assignees: A issue pode ser atribuída a um ou mais colaboradores do projeto utilizando essa seção
Descrição: Qualquer informação que possa auxiliar na compreensão ou resolução da issue (lembrando que uma issue pode ser desde um bug até uma ideia de feature nova).
- Você pode marcar outras issues, com #, ou marcar pessoas com @

Até aqui podemos ver o poder e a quantidade de informação que podemos armazenar com as issues, mas é só isso? Não!! Há um ponto importante que temos que destacar quando estamos lidando com várias pessoas contribuindo em um projeto.

Acompanhando uma issue

Criar a issue é apenas o primeiro passo! Acompanhar uma issue é uma parte fundamental do gerenciamento de projetos e colaboração eficaz no GitHub. Mas como se manter atualizado das discussões? Bem, temos algumas formas:

Ative as notificações para acompanhar qualquer atividade relacionada a ela. Clique na opção "Subscribe" na parte superior direita da issue para receber alertas por e-mail sempre que houver novos comentários, mudanças de status ou atualizações.
Participe ativamente das discussões na issue. Comente, forneça feedback e colabore com a equipe. Essas discussões podem levar a ideias melhores e a uma compreensão mais clara dos requisitos da tarefa.
Atribua a issue ou marque-o (com @) a um membro da equipe responsável pelo desenvolvimento. Isso ajuda a evitar confusões sobre quem está trabalhando na tarefa e permite um acompanhamento direcionado.
Utilize milestones para definir marcos ou metas específicas para a issue. À medida que o trabalho avança, atualize o status da issue e mova-a para o milestone correspondente. Isso proporciona uma visão clara do progresso geral do projeto.
Mantenha a descrição da issue atualizada à medida que o desenvolvimento progride. Isso inclui adicionar informações relevantes, capturas de tela, links ou quaisquer detalhes importantes que surgirem durante o processo.

E por último mas não menos importante... Quando a tarefa estiver concluída, certifique-se de que o trabalho seja revisado e testado. Comente na issue indicando que a tarefa está pronta para revisão ou integração. Após a revisão bem-sucedida, feche a issue. Se houver ajustes futuros, é só mencionar, a issue continuará salva e poderá ser reaberta se necessário.

Conclusão

Agora você está equipado com o poder das issues no GitHub! Elas são como post-its digitais que mantêm seu projeto na linha. Lembram o que você estava pensando (ou não) e ajudam a galera toda a trabalhar junto, mesmo quando o mundo está de cabeça para baixo.

Lembrou de uma ideia brilhante no meio da noite? Pode criar uma issue! Quer atribuir tarefas? É só marcar alguém com um 'arroba'. E não se preocupe, quando você tiver feito o seu trampo, é só revisar, testar e fechar a issue.

Então, da próxima vez que você mergulhar no código, lembre-se das suas amigas issues, elas vão fazer seu trabalho render mais e podem te poupar de futuros momentos "que diabos eu estava fazendo aqui".

Psst, você aí! Quer agilizar ainda mais a criação de issues num projeto? Fica ligado no GitHub Projects

Links e referências

Issues | Doc do GitHub
Git4Noobs - Passo a passo para quem está começando agora
Cover por Mimi Thian no Unsplash

A Comp Júnior!

Nossa missão é oferecer a transformação digital aos nossos clientes, expandindo os seus negócios para o mercado digital e alcançando um potencial desconhecido.

Se você quer saber mais, acesse nosso site!
Ou, se preferir, acesse nosso Instagram!

O que é uma Empresa Júnior?

Gustavo — Mon, 14 Aug 2023 17:44:17 +0000

Introdução
Por que entrar em uma empresa júnior?
O Movimento Empresa Júnior
TL;DR; - Resumão
A Comp Júnior

Introdução

Uma empresa é uma organização que reúne recursos humanos, financeiros e materiais com o objetivo de desenvolver e oferecer produtos, serviços ou soluções para atender às necessidades do mercado.

Ser júnior refere-se a uma fase inicial da carreira profissional, geralmente associada a indivíduos que estão nos primeiros anos de atuação em uma determinada área ou empresa. Profissionais juniores estão em processo de aprendizado e desenvolvimento, frequentemente sob a orientação e supervisão de colegas mais experientes. Essa etapa é marcada por oportunidades de crescimento, aquisição de habilidades práticas e conhecimento específico, além de proporcionar um ambiente propício para explorar diferentes aspectos do trabalho e construir uma base sólida para o progresso profissional futuro.

Mas como uma empresa se encaixa nisso?

Uma empresa júnior é uma organização estudantil sem fins lucrativos, associada a uma universidade ou faculdade.

Ela opera como uma entidade empresarial controlada por alunos, proporcionando uma experiência prática, por meio de projetos reais, os membros da empresa júnior aplicam conhecimentos teóricos adquiridos em sala de aula para enfrentar desafios reais do mercado. Essa abordagem permite que os estudantes desenvolvam habilidades profissionais, como trabalho em equipe, liderança e resolução de problemas, enquanto oferecem serviços de qualidade a clientes reais a preços acessíveis. O termo "júnior" denota o caráter educacional da organização, indicando que os participantes estão em uma fase de aprendizado e crescimento, sob a supervisão de professores e profissionais do setor, preparando-se para suas futuras carreiras.

Por que entrar em uma empresa júnior?

Muitos no ambiente universitário nunca tiveram contato com empresas do seu segmento de estudo, ou seja, não sabem como colocar em prática o conteúdo teórico aprendido durante o curso.

Além disso, a universidade acaba deixando de lado as soft skills, que são habilidades interpessoais e sociais que afetam a maneira como nos relacionamos com os outros e lidamos com situações do dia a dia.

Com isso em mente, uma empresa júnior é responsável por acolher e desenvolver seus membros, oferecendo a primeira oportunidade profissional e contato com o mercado de trabalho, suas metodologias e estruturas.

Em uma empresa júnior, você é encorajado a tomar suas próprias decisões e a pedir ajuda, não somente para os membros da sua empresa, mas para toda a rede.

Mas que rede é essa?

O MEJ

O Movimento Empresa Júnior (MEJ para os íntimos) atua como uma rede que reúne diversas empresas juniores, oferecendo suporte, capacitação e troca de experiências entre essas organizações. Ele busca fomentar a cultura empreendedora entre os estudantes universitários, estimulando-os a aplicar os conhecimentos adquiridos em sala de aula em projetos reais, e ao mesmo tempo contribuir para o desenvolvimento de empresas e comunidades locais.

A estrutura está pelos membros, e não os membros pela estrutura

Isso quer dizer que, se tivermos alguma dificuldade, seja estratégica, tática ou operacional, temos toda uma rede que provavalmente já passou pela mesma coisa. E temos total liberdade (na verdade, somos encorajados) a pedir por conselhos e ajuda de toda a rede!

TLDR

Empresa Júnior:

Organização estudantil sem fins lucrativos associada a uma universidade.
Controlada por alunos, oferece experiência prática por meio de projetos reais.
Aplica conhecimentos teóricos em desafios de mercado.
Desenvolve habilidades profissionais e oferece serviços a clientes reais.

Benefícios de uma empresa júnior:

Colocar em prática conhecimentos teóricos do curso.
Desenvolver soft skills (habilidades interpessoais).
Oferecer primeira oportunidade profissional e contato com o mercado.
Tomar decisões e buscar ajuda dentro de uma rede.

Movimento Empresa Júnior:

Rede que reúne empresas juniores.
Oferece suporte, capacitação e troca de experiências.
Estimula cultura empreendedora e aplicação de conhecimentos em projetos reais.
Ênfase na colaboração e apoio mútuo entre membros.

A Comp Júnior

A Comp Júnior é uma EJ (Empresa Júnior) que atua no mercado de tecnologia há mais de 20 anos em Lavras e região, prestando serviço de desenvolvimento web, mobile e multiplataforma.

Nossa missão é oferecer a transformação digital aos nossos clientes, expandindo os seus negócios para o mercado digital e alcançando um potencial desconhecido.

Se você quer saber mais, acesse nosso site!
Ou, se preferir, acesse nosso Instagram!