https://github.com/arielspencer/issue

👾 Este guia irá ajudá-lo a entender como criar uma issue de forma clara e concisa.
https://github.com/arielspencer/issue

github issue issues open-source tutorial

Last synced: about 9 hours ago
JSON representation

👾 Este guia irá ajudá-lo a entender como criar uma issue de forma clara e concisa.

• Host: GitHub
• URL: https://github.com/arielspencer/issue
• Owner: ArielSpencer
• License: mit
• Created: 2024-07-16T19:40:53.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-16T23:57:04.000Z (4 months ago)
• Last Synced: 2024-07-18T00:13:26.610Z (4 months ago)
• Topics: github, issue, issues, open-source, tutorial
• Homepage:
• Size: 130 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Static Badge](https://img.shields.io/badge/Ariel%20Spencer-Issue-%238472E8) ![GitHub License](https://img.shields.io/github/license/arielspencer/issue)

![Como fazer uma issues no github](https://github.com/ArielSpencer/Issue/blob/dd54746ebef677a8cc205db025fd104bc298a193/issues-github-capa.png)

# Como Criar uma Issue

As _issues_ são uma maneira eficaz de relatar bugs, solicitar novas funcionalidades ou discutir melhorias para o projeto. Este guia irá ajudá-lo a entender como criar uma _issue_ de forma clara e concisa.

## Para que serve uma Issue?

Uma _issue_ serve para:

- **Relatar Bugs:** Informar sobre erros ou problemas encontrados na aplicação.

- **Solicitar Funcionalidades:** Sugerir novas funcionalidades ou melhorias que podem ser implementadas.

- **Discutir Melhorias:** Propor alterações que podem otimizar o projeto.

## Como Criar uma Issue

Siga os passos abaixo para criar uma _issue_:

1. **Acesse o Repositório:**

   Vá para a página do repositório no GitHub.

2. **Navegue até a Aba de Issues:**

   Clique na aba **"Issues"** na parte superior da página do repositório.

3. **Crie uma Nova Issue:**

   Clique no botão **"New Issue"**.

4. **Escolha um Template (se disponível):**

   Se o repositório tiver templates para _issues_, selecione o que mais se adequa ao seu caso (por exemplo, bug report ou feature request).

5. **Preencha o Título e a Descrição:**

   - **Título:** Seja claro e sucinto ao descrever o problema ou a sugestão.

   - **Descrição:** Forneça detalhes relevantes, como:

     - O que aconteceu?

     - Como reproduzir o problema (se for um bug)?

     - Qual é a sua sugestão (se for uma nova funcionalidade)?

     - Informações adicionais, como screenshots ou logs de erro, se aplicável.

6. **Clique em "Submit new issue":**

   Após preencher as informações, clique no botão **"Submit new issue"** para enviar.

## Exemplo de uma Issue

**Título:**

Bug ao enviar um formulário.

**Descrição:**

```

Ao tentar enviar o formulário de contato, recebo um erro 500.

Isso acontece sempre que o campo "Email" está vazio.

Passos para reproduzir:

1. Acesse a página de contato.

2. Deixe o campo "Email" em branco.

3. Clique em "Enviar".

```

**Screenshots:**

[Anexar imagens, se necessário]

---

Ao seguir estas etapas, você ajudará a manter o projeto organizado e facilitará a colaboração.

---

Não deixe de conferir como criar um pull request de maneira descomplicada: [pull request](https://github.com/ArielSpencer/pull-request).