diff --git a/.github/ISSUE_TEMPLATE/bug_report_br.yaml b/.github/ISSUE_TEMPLATE/bug_report_br.yaml index e353cdd8..5b83c8ec 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_br.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report_br.yaml @@ -3,26 +3,24 @@ description: Create a report to help us improve. labels: - bug - help wanted + - pt-br assignees: jrcleber body: - - type: checkboxes - id: terms + - type: markdown attributes: - label: Bem-vido! - description: | + value: '## Bem-vindo!' + + - type: markdown + attributes: + value: | O rastreador de problemas é apenas para relatar bugs e solicitações de recursos. Para perguntas de suporte relacionadas ao usuário final, acesse o [Grupo](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5). - NÃO ABRA UM PROBLEMA PARA PERGUNTAS GERAIS DE SUPORTE. + **NÃO ABRA UM PROBLEMA PARA PERGUNTAS GERAIS DE SUPORTE.** - options: - - label: Sim, pesquisei problemas semelhantes no [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) e não encontrei nenhum. - required: true - - - type: textarea + - type: markdown attributes: - label: O que você fez? - description: | + value: | Como escrever um bom relatório de bug? - Respeite o modelo de problema tanto quanto possível. @@ -31,37 +29,75 @@ body: - 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: O que você fez? + + --- + + - type: checkboxes + id: terms + attributes: + label: Pesquisei problemas semelhantes no [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) e não encontrei nenhum. + description: Pesquise tanto nas issue abertas quanto nas fechadas. + options: + - label: Sim + required: true + + - type: markdown + attributes: + value: '### O que você fez?' + - type: textarea + attributes: + label: 'Quais passos para chegar ao problema?' + placeholder: Descreva validations: required: true + - type: markdown + attributes: + value: '### O que você esperava?' - type: textarea attributes: - label: O que você esperava? + label: Descreva o que você esperava que acontecesse. placeholder: O que você esperava? validations: required: true + - type: markdown + attributes: + value: '### O que vc observou ao invés do que esperava?' - type: textarea attributes: - label: O que vc observou ao invés do que esperava? + label: Explique o que realmente acontece quando você segue os passos acima. placeholder: O que vc observou ao invés do que esperava? validations: required: true + - type: markdown + attributes: + value: '### Qual versão da API você está usando?' - 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**. + label: 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: markdown + attributes: + value: '### Capturas de Tela/Vídeos' + - type: textarea + attributes: + label: | + Se possível, adicione capturas de tela ou vídeos que ilustrem o problema. + Isso pode ser extremamente útil para entender melhor o problema. + placeholder: mídioas que ajudam a identificar o problema + + - type: markdown + attributes: + value: '### Qual é o seu ambiente?' - type: dropdown id: select attributes: - label: Qual é o seu ambiente? + label: O ambiente no qual a aplicação está em execução options: - Windows - Linux @@ -71,10 +107,23 @@ body: validations: required: true + - type: markdown + attributes: + value: '### Se aplicável, cole a saída do log' - type: textarea attributes: - label: Se aplicável, cole a saída do log - description: "`console da aplicação`" + label: | + 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: markdown + attributes: + value: '### Notas Adicionais' + - type: textarea + attributes: + label: 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/bug_report_en.yaml b/.github/ISSUE_TEMPLATE/bug_report_en.yaml index 4e0c1fe7..2e20d2ad 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_en.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report_en.yaml @@ -1,80 +1,129 @@ -name: Bug Report (CodeChat - EN) +name: Bug Report (CodeChat) description: Create a report to help us improve. labels: - bug - help wanted + - en assignees: jrcleber body: - - type: checkboxes - id: terms - attributes: - label: Welcome! - description: | - The issue tracker is only for reporting bugs and feature requests. - For end-user related support questions, please visit [Group](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5). + - type: markdown + attributes: + value: '## Welcome!' - DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS. + - type: markdown + attributes: + value: | + The issue tracker is only for reporting bugs and feature requests. + For end-user support questions, please visit the [Group](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5). - options: - - label: Yes, I searched for similar issues on [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) and didn't find any. - required: true + **DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS.** - - type: textarea - attributes: - label: What did you do? - description: | - How to write a good bug report? + - type: markdown + attributes: + value: | + How to write a good bug report? - - Respect the problem model as much as possible. - - The title must be short and descriptive. - - Explain the conditions that led you to report this problem: the context. - - The context should lead to something, 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: What did you do? - validations: - required: true + - Follow 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) - - type: textarea - attributes: - label: What did you expect? - placeholder: What did you expect? - validations: - required: true + --- - - type: textarea - attributes: - label: What did you observe instead of what you expected? - placeholder: What did you observe instead of what you expected? - validations: - required: true + - type: checkboxes + id: terms + attributes: + label: I have searched for similar issues on [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) and found none. + description: Search both open and closed issues. + options: + - label: Yes + required: true - - type: textarea - attributes: - label: Which API version are you using? - description: | - Enter your version number that is in the `version` property of **package.json**. - placeholder: Paste the version here. - validations: - required: true + - type: markdown + attributes: + value: '### What did you do?' + - type: textarea + attributes: + label: 'Steps to reproduce the issue' + placeholder: Describe + validations: + required: true - - type: dropdown - id: select - attributes: - label: What is your environment? - options: - - Windows - - Linux - - Mac - - Docker - - Other - validations: - required: true + - type: markdown + attributes: + value: '### What did you expect?' + - type: textarea + attributes: + label: Describe what you expected to happen. + placeholder: What did you expect? + validations: + required: true - - type: textarea - attributes: - label: If applicable, paste the log output - description: "`application console`" - placeholder: Paste the application log here - validations: - required: false \ No newline at end of file + - type: markdown + attributes: + value: '### What did you observe instead of what you expected?' + - type: textarea + attributes: + label: Explain what actually happens when you follow the steps above. + placeholder: What did you observe instead of what you expected? + validations: + required: true + + - type: markdown + attributes: + value: '### Which version of the API are you using?' + - type: textarea + attributes: + label: Enter the version number found in the `version` property of **package.json**. + placeholder: Paste the version here. + validations: + required: true + + - type: markdown + attributes: + value: '### Screenshots/Videos' + - type: textarea + attributes: + label: | + If possible, add screenshots or videos that illustrate the issue. + This can be extremely helpful to better understand the issue. + placeholder: media that helps identify the issue + + - type: markdown + attributes: + value: '### What is your environment?' + - type: dropdown + id: select + attributes: + label: The environment in which the application is running + options: + - Windows + - Linux + - Mac + - Docker + - Other + validations: + required: true + + - type: markdown + attributes: + value: '### If applicable, paste the log output' + - type: textarea + attributes: + label: | + 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: markdown + attributes: + value: '### Additional Notes' + - type: textarea + attributes: + label: Include any other information you think might be useful to understand or resolve the bug. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/future-request.yaml b/.github/ISSUE_TEMPLATE/future-request.yaml deleted file mode 100644 index c1ea9c81..00000000 --- a/.github/ISSUE_TEMPLATE/future-request.yaml +++ /dev/null @@ -1,65 +0,0 @@ -name: Solicitação de recursos (CodeChat) -description: Sugira ideias para o projeto. -assignees: jrcleber -labels: - - enhancement -body: - - type: checkboxes - id: terms - attributes: - label: Bem-vindo! - description: NÃO ABRA PARA PERGUNTAS GERAIS DE SUPORTE. - - options: - - label: Sim, pesquisei problemas 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? - placeholder: Descreva a motivação para o recurso - validations: - required: true - - - 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`? - placeholder: Insira ideias para o recurso - validations: - required: true - - - type: textarea - attributes: - label: Pode ser construído com o n8n? - description: | - Quais nós podem ser usados? - Descreva o fluxo. - placeholder: Descreva o workflow - validations: - required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/future-request_br.yaml b/.github/ISSUE_TEMPLATE/future-request_br.yaml new file mode 100644 index 00000000..0a4aa2fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/future-request_br.yaml @@ -0,0 +1,123 @@ +name: Solicitação de recursos (CodeChat) +description: Sugira ideias para o projeto. +assignees: jrcleber +labels: + - enhancement + - pt-br +body: + - type: markdown + attributes: + value: '## Bem-vindo!' + + - type: markdown + attributes: + value: | + O rastreador de problemas é apenas para relatar bugs e solicitações de recursos. + Para perguntas de suporte relacionadas ao usuário final, acesse o [Grupo](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5). + + **NÃO ABRA UM PROBLEMA PARA PERGUNTAS GERAIS DE SUPORTE.** + + - type: markdown + attributes: + value: | + 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) + + --- + + - type: checkboxes + id: terms + attributes: + label: Pesquisei problemas semelhantes no Github e não encontrei nenhum. + description: Pesquise tanto nas [issue abertas quanto nas fechadas](https://github.com/code-chat-br/whatsapp-api/issues). + options: + - label: Sim + required: true + + - type: markdown + attributes: + value: '### Qual tipo de recurso?' + - type: dropdown + attributes: + label: 'Recurso de:' + options: + - Integração + - Funcionalidade + - Endpoint + - Ajuste de banco de dados + - Outro + validations: + required: true + + - type: markdown + attributes: + value: '### Qual a motivação para a solicitação?' + - type: textarea + attributes: + label: Qual problema o recurso busca resolver? + placeholder: Descreva a motivação para o recurso + validations: + required: true + + - type: markdown + attributes: + value: '### Exemplos de Uso' + - type: textarea + attributes: + label: | + 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: markdown + attributes: + value: '### Como o recurso deve ser desenvolvido?' + - type: textarea + attributes: + label: Desenvolvimento + 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: markdown + attributes: + value: '### Pode ser construído com o n8n?' + - type: textarea + attributes: + label: n8n + description: | + Quais nós podem ser usados? + Descreva o fluxo. + placeholder: Descreva o workflow + validations: + required: false + + - type: markdown + attributes: + value: '### Notas Adicionais' + - type: textarea + attributes: + label: Qualquer outra informação que você acredita ser relevante para a sua solicitação. + placeholder: Insira aqui as sua observções. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/future-request_en.yaml b/.github/ISSUE_TEMPLATE/future-request_en.yaml new file mode 100644 index 00000000..08b002fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/future-request_en.yaml @@ -0,0 +1,123 @@ +name: Feature Request (CodeChat) +description: Suggest ideas for the project. +assignees: jrcleber +labels: + - enhancement + - en +body: + - type: markdown + attributes: + value: '## Welcome!' + + - type: markdown + attributes: + value: | + The issue tracker is only for reporting bugs and feature requests. + For end-user support questions, please visit the [Group](https://chat.whatsapp.com/HyO8X8K0bAo0bfaeW8bhY5). + + **DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS.** + + - type: markdown + attributes: + value: | + How to write a good feature request? + + - Follow 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) + + --- + + - type: checkboxes + id: terms + attributes: + label: I have searched for similar requests on GitHub and found none. + description: Search both [open and closed issues](https://github.com/code-chat-br/whatsapp-api/issues). + options: + - label: 'Yes' + required: true + + - type: markdown + attributes: + value: '### What type of feature?' + - type: dropdown + attributes: + label: 'Feature type:' + options: + - Integration + - Functionality + - Endpoint + - Database adjustment + - Other + validations: + required: true + + - type: markdown + attributes: + value: '### What is the motivation for the request?' + - type: textarea + attributes: + label: What problem does the feature aim to solve? + placeholder: Describe the motivation for the feature + validations: + required: true + + - type: markdown + attributes: + value: '### Examples of Use' + - type: textarea + attributes: + label: | + Provide specific examples of how this feature 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: markdown + attributes: + value: '### How should the feature be developed?' + - type: textarea + attributes: + label: Development + description: | + Should it be integrated directly into the code? + Should it be built as a separate application that acts as an extension of the API? + For example: a `worker`? + + Discuss how this new functionality might impact other parts of the project, if applicable. + + --- + + If you have ideas on how this feature can be implemented, please share them here. + This is not mandatory but can be useful for the development team. + + placeholder: Insert ideas for the feature + validations: + required: false + + - type: markdown + attributes: + value: '### Can it be built with n8n?' + - type: textarea + attributes: + label: n8n + description: | + What nodes can be used? + Describe the workflow. + placeholder: Describe the workflow + validations: + required: false + + - type: markdown + attributes: + value: '### Additional Notes' + - type: textarea + attributes: + label: Any other information you believe is relevant to your request. + placeholder: Insert your notes here. + validations: + required: false