diff --git a/.github/ISSUE_TEMPLATE/-en--bug-report.md b/.github/ISSUE_TEMPLATE/-en--bug-report.md deleted file mode 100644 index 52579cb2..00000000 --- a/.github/ISSUE_TEMPLATE/-en--bug-report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: "[EN] Bug report" -about: Create a report to help us improve -title: "[EN][BUG]" -labels: bug -assignees: '' - ---- - -### Title: [Brief Description of the Bug] - -#### Description: -Describe in detail the problem you encountered. Include any relevant context that may help understand the origin of the bug. - -#### Steps to Reproduce: -1. List the steps necessary to reproduce the problem. -2. Try to be as specific as possible. -3. If the problem occurs in a specific scenario, describe it here. - -#### Expected Behavior: -Describe what you expected to happen when following the steps above. - -#### Current Behavior: -Explain what actually happens when you follow the steps above. - -#### Screenshots/Videos: -If possible, add screenshots or videos illustrating the problem. This can be extremely helpful in understanding the issue. - -#### Environment: -- **Server:** [e.g., Ubuntu 18.04] -- **API Version:** [e.g., 1.5.4] -- **Other Hardware/Software Specifications:** [e.g., CPU, GPU] - -#### Submitting Logs: -Please attach logs that may be related to the problem. If the logs contain sensitive information, consider sending them privately to one of the project maintainers. - -#### Additional Notes: -Include here any other information that you think might be useful in understanding or resolving the bug. diff --git a/.github/ISSUE_TEMPLATE/-en--bug-report.yaml b/.github/ISSUE_TEMPLATE/-en--bug-report.yaml new file mode 100644 index 00000000..adf0322a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-en--bug-report.yaml @@ -0,0 +1,106 @@ +name: Bug Report +description: Create a report to help us improve. +labels: + - bug + # - help wanted +# Automatically assign the issue to: +# assignees: DavidsonGomes +body: + - type: checkboxes + id: terms + attributes: + label: Welcome! + description: | + The issue tracker is only for reporting bugs and feature requests. + For user-related support questions, please visit: + - [Discord](https://evolution-api.com/discord) + - [WhatsApp Group](https://evolution-api.com/whatsapp) +
+ + **DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS.** + + options: + - label: Yes, I have searched for similar issues on [GitHub](https://github.com/EvolutionAPI/evolution-api/issues) and found none. + required: true + + - type: textarea + attributes: + label: What did you do? + description: | + How to write a good bug report? + + - Respect the issue template as much as possible. + - The title should be short and descriptive. + - Explain the conditions that led you to report this issue: the context. + - The context should lead to something, an idea or problem you are facing. + - Be clear and concise. + - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) + placeholder: Describe the problem you encountered in detail. + validations: + required: true + + - type: textarea + attributes: + label: What did you expect? + placeholder: Describe what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: What did you observe instead of what you expected? + placeholder: Explain what actually happens when you follow the steps above. + validations: + required: true + + - type: textarea + attributes: + label: Screenshots/Videos + placeholder: | + If possible, add screenshots or videos that illustrate the problem. This can be extremely helpful in understanding the issue better. + + - type: textarea + attributes: + label: Which version of the API are you using? + description: | + Enter the version number found in the `version` property of the **package.json**. + placeholder: Paste the version here. + validations: + required: true + + - type: dropdown + id: select + attributes: + label: What is your environment? + options: + - Windows + - Linux + - Mac + - Docker + - Other + validations: + required: true + + - type: textarea + attributes: + label: Other environment specifications + placeholder: 'Hardware/Software: [e.g., CPU, GPU]' + validations: + required: false + + - type: textarea + attributes: + label: If applicable, paste the log output + description: | + Please attach any logs that might be related to the issue. + If the logs contain sensitive information, consider sending them privately to one of the project maintainers. + placeholder: Paste the application log here. + validations: + required: false + + - type: textarea + attributes: + label: Additional Notes + description: Include any other information you think might be useful to understand or resolve the bug. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/-en--feature-request.md b/.github/ISSUE_TEMPLATE/-en--feature-request.md deleted file mode 100644 index df7959c6..00000000 --- a/.github/ISSUE_TEMPLATE/-en--feature-request.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "[EN] Feature request" -about: Suggest an idea for the API -title: "[EN][FEAT]" -labels: enhancement -assignees: '' - ---- - -### Title: [Brief Description of Feature Request] - -#### Detailed Description: -Clearly and in detail, describe the functionality you wish to be implemented. Explain how this fits into the context of the project. - -#### Rationale: -Explain why this functionality would be useful for the project. This helps in understanding the importance and priority of the request. - -#### Usage Examples: -Provide specific examples of how this feature could be used. This can include scenarios or use cases where the feature would be particularly beneficial. - -#### Possible Implementations: -If you have ideas on how this feature might be implemented, please share them here. This is not mandatory but can be helpful for the development team. - -#### Impact on the Project: -Discuss how this new feature could impact other parts of the project, if applicable. - -#### Additional Notes: -Any other information you believe is relevant to your request. diff --git a/.github/ISSUE_TEMPLATE/-en--feature-request.yaml b/.github/ISSUE_TEMPLATE/-en--feature-request.yaml new file mode 100644 index 00000000..65c4acab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-en--feature-request.yaml @@ -0,0 +1,85 @@ +name: Feature Request +description: Suggest ideas for the project. +labels: + - enhancement +# Automatically assign the issue to: +# assignees: DavidsonGomes +body: + - type: checkboxes + id: terms + attributes: + label: Welcome! + description: '**DO NOT OPEN FOR GENERAL SUPPORT QUESTIONS.**' + + options: + - label: Yes, I have searched for similar requests on [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) and found none. + required: true + + - type: dropdown + attributes: + label: What type of feature? + description: | + How to write a good feature request? + + - Respect the issue template as much as possible. + - The title should be short and descriptive. + - Explain the conditions that led you to suggest this feature: the context. + - The context should lead to something, an idea or problem you are facing. + - Be clear and concise. + - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) + options: + - Integration + - Functionality + - Endpoint + - Database adjustment + - Other + validations: + required: true + + - type: textarea + attributes: + label: What is the motivation for the request? + description: | + What problem does the feature seek to solve? + Clearly and in detail describe the functionality you want to be implemented. + Explain how it fits into the context of the project. + placeholder: Detailed description + validations: + required: true + + - type: textarea + attributes: + label: Usage Examples + description: | + Provide specific examples of how this functionality could be used. + This can include scenarios or use cases where the feature would be particularly beneficial. + placeholder: text - image - video - flowcharts + validations: + required: false + + - type: textarea + attributes: + label: How should the feature be developed? + description: | + Should it be inserted directly into the code? + Should it be built as a different application that acts as an extension of the API? + For example: a `worker`? + + Discuss how this new functionality could impact other parts of the project, if applicable. + + --- + + If you have ideas on how this functionality could be implemented, please share them here. + This is not mandatory, but it can be helpful for the development team. + + placeholder: Insert feature ideas here + validations: + required: false + + - type: textarea + attributes: + label: Additional Notes + description: Any other information you believe is relevant to your request. + placeholder: Insert your observations here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/-pt--reportar-bug.md b/.github/ISSUE_TEMPLATE/-pt--reportar-bug.md deleted file mode 100644 index 7c99f991..00000000 --- a/.github/ISSUE_TEMPLATE/-pt--reportar-bug.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: "[PT] Reportar bug" -about: Reportar um problema -title: "[PT][BUG]" -labels: bug -assignees: '' - ---- - -### Título: [Breve Descrição do Bug] - -#### Descrição: -Descreva detalhadamente o problema que você encontrou. Inclua qualquer contexto relevante que possa ajudar a entender a origem do bug. - -#### Passos para Reproduzir: -1. Liste os passos necessários para reproduzir o problema. -2. Tente ser o mais específico possível. -3. Se o problema ocorrer em um cenário específico, descreva-o aqui. - -#### Comportamento Esperado: -Descreva o que você esperava que acontecesse quando seguisse os passos acima. - -#### Comportamento Atual: -Explique o que realmente acontece quando você segue os passos acima. - -#### Capturas de Tela/Vídeos: -Se possível, adicione capturas de tela ou vídeos que ilustrem o problema. Isso pode ser extremamente útil para entender o problema. - -#### Ambiente: -- **Servidor:** [ex: Ubuntu 18.04] -- **Versão da API:** [ex: 1.5.4] -- **Outras Especificações de Hardware/Software:** [ex: CPU, GPU] - -#### Envio de Logs: -Por favor, anexe os logs que possam estar relacionados ao problema. Se os logs contiverem informações sensíveis, considere enviá-los de forma privada para um dos mantenedores do projeto. - -#### Notas Adicionais: -Inclua aqui qualquer outra informação que você ache que possa ser útil para entender ou resolver o bug. diff --git a/.github/ISSUE_TEMPLATE/-pt--reportar-bug.yaml b/.github/ISSUE_TEMPLATE/-pt--reportar-bug.yaml new file mode 100644 index 00000000..fe2409c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-pt--reportar-bug.yaml @@ -0,0 +1,107 @@ +name: Relatório de bug +description: Crie um relatório para nos ajudar a melhorar. +labels: + - bug + # - help wanted +# Atrubuir automaticamente a issue a: +# assignees: DavidsonGomes +body: + - type: checkboxes + id: termos + attributes: + label: Bem-vido! + description: | + O rastreador de problemas é apenas para relatar bugs e solicitações de recursos. + Para perguntas de suporte relacionadas ao usuário final, acesse: + - [Discord](https://evolution-api.com/discord) + - [Grupo do WhatsApp](https://evolution-api.com/whatsapp) +
+ + **NÃO ABRA UM PROBLEMA PARA PERGUNTAS GERAIS DE SUPORTE.** + + options: + - label: Sim, pesquisei problemas semelhantes no [GitHub](https://github.com/EvolutionAPI/evolution-api/issues) e não encontrei nenhum. + required: true + + - type: textarea + attributes: + label: O que você fez? + description: | + Como escrever um bom relatório de bug? + + - Respeite o modelo de problema tanto quanto possível. + - O título deve ser curto e descritivo. + - Explique as condições que o levaram a reportar este problema: o contexto. + - O contexto deve levar a algo, ideia ou problema que você está enfrentando. + - Seja claro e conciso. + - Formate suas mensagens para ajudar o leitor a se concentrar no que importa e entender a estrutura da sua mensagem, use [sintaxe Markdown](https://help.github.com/articles/github-flavored-markdown) + placeholder: Descreva detalhadamente o problema que você encontrou. + validations: + required: true + + - type: textarea + attributes: + label: O que você esperava? + placeholder: Descreva o que você esperava que acontecesse. + validations: + required: true + + - type: textarea + attributes: + label: O que vc observou ao invés do que esperava? + placeholder: Explique o que realmente acontece quando você segue os passos acima. + validations: + required: true + + - type: textarea + attributes: + label: Capturas de Tela/Vídeos + placeholder: | + Se possível, adicione capturas de tela ou vídeos que ilustrem o problema. Isso pode ser extremamente útil para entender melhor o problema. + + - type: textarea + attributes: + label: Qual versão da API você está usando? + description: | + Insira o número da sua versão que está na propriedade `version` do **package.json**. + placeholder: Cole aqui a versão. + validations: + required: true + + - type: dropdown + id: select + attributes: + label: Qual é o seu ambiente? + options: + - Windows + - Linux + - Mac + - Docker + - Outro + validations: + required: true + + - type: textarea + attributes: + label: Outras expecificações do ambiente + placeholder: 'Hardware/Software: [ex: CPU, GPU]' + validations: + required: false + + - type: textarea + attributes: + label: Se aplicável, cole a saída do log + description: | + Por favor, anexe os logs que possam estar relacionados ao problema. + Se os logs contiverem informações sensíveis, considere enviá-los de forma privada para um dos mantenedores do projeto. + placeholder: Cole aqui o log da aplicação + validations: + required: false + + - type: textarea + attributes: + label: Notas Adicionais + description: Inclua aqui qualquer outra informação que você ache que possa ser útil para entender ou resolver o bug. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.md b/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.md deleted file mode 100644 index 900389fd..00000000 --- a/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "[PT] Solicitar recurso" -about: Sugira novos recursos para a API -title: "[PT][FEAT]" -labels: enhancement -assignees: '' - ---- - -### Título: [Breve Descrição da Solicitação de Recurso] - -#### Descrição Detalhada: -Descreva claramente e em detalhes a funcionalidade que você deseja que seja implementada. Explique como isso se encaixa no contexto do projeto. - -#### Racional: -Explique por que essa funcionalidade seria útil para o projeto. Isso ajuda a entender a importância e a prioridade da solicitação. - -#### Exemplos de Uso: -Forneça exemplos específicos de como essa funcionalidade poderia ser utilizada. Isso pode incluir cenários ou casos de uso onde a funcionalidade seria particularmente benéfica. - -#### Possíveis Implementações: -Se você tem ideias sobre como essa funcionalidade pode ser implementada, por favor, compartilhe-as aqui. Isso não é obrigatório, mas pode ser útil para a equipe de desenvolvimento. - -#### Impacto no Projeto: -Discuta como essa nova funcionalidade poderia impactar outras partes do projeto, se aplicável. - -#### Notas Adicionais: -Qualquer outra informação que você acredita ser relevante para a sua solicitação. diff --git a/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.yaml b/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.yaml new file mode 100644 index 00000000..02c30ae3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-pt--solicitar-recurso.yaml @@ -0,0 +1,85 @@ +name: Solicitação de recursos +description: Sugira ideias para o projeto. +labels: + - enhancement +# Automatically assign the issue to: +# assignees: DavidsonGomes +body: + - type: checkboxes + id: termos + attributes: + label: Bem-vindo! + description: '**NÃO ABRA PARA PERGUNTAS GERAIS DE SUPORTE.**' + + options: + - label: Sim, pesquisei solicitações semelhantes no [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) e não encontrei nenhum. + required: true + + - type: dropdown + attributes: + label: Qual tipo de recurso? + description: | + Como escrever uma boa solicitação de bug? + + - Respeite o modelo de problema tanto quanto possível. + - O título deve ser curto e descritivo. + - Explique as condições que o levaram a reportar este problema: o contexto. + - O contexto deve levar a algo, ideia ou problema que você está enfrentando. + - Seja claro e conciso. + - Formate suas mensagens para ajudar o leitor a se concentrar no que importa e entender a estrutura da sua mensagem, use [sintaxe Markdown](https://help.github.com/articles/github-flavored-markdown) + options: + - Integração + - Funcionalidade + - Endpoint + - Ajuste de banco de dados + - Outro + validations: + required: true + + - type: textarea + attributes: + label: Qual a motivação para a solicitação? + description: | + Qual problema o recurso busca resolver? + Descreva claramente e em detalhes a funcionalidade que você deseja que seja implementada. + Explique como isso se encaixa no contexto do projeto. + placeholder: Descrição detalhada + validations: + required: true + + - type: textarea + attributes: + label: Exemplos de Uso + description: | + Forneça exemplos específicos de como essa funcionalidade poderia ser utilizada. + Isso pode incluir cenários ou casos de uso onde a funcionalidade seria particularmente benéfica. + placeholder: texto - imagem - video - fluxogramas + validations: + required: false + + - type: textarea + attributes: + label: Como o recurso deve ser desenvolvido? + description: | + Deve ser inserido diretamente no código? + Deve ser construído uma aplicação diferente que atuará como uma extenção da api? + Por exemplo: um `worker`? + + Discuta como essa nova funcionalidade poderia impactar outras partes do projeto, se aplicável. + + --- + + Se você tem ideias sobre como essa funcionalidade pode ser implementada, por favor, compartilhe-as aqui. + Isso não é obrigatório, mas pode ser útil para a equipe de desenvolvimento. + + placeholder: Insira ideias para o recurso + validations: + required: false + + - type: textarea + attributes: + label: Notas Adicionais + description: Qualquer outra informação que você acredita ser relevante para a sua solicitação. + placeholder: Insira aqui as sua observções. + validations: + required: false