From 342d5a75e898d7db6c70de913800ffcc15421506 Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Fri, 3 Jun 2022 08:59:21 -0500 Subject: [PATCH 1/2] Improve Github issue template --- .github/ISSUE_TEMPLATE/config.yml | 11 ++++++--- .github/ISSUE_TEMPLATE/issue.yml | 41 ++++++++++++++++++++++++------- 2 files changed, 39 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 02189b3103e..30e10de3508 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,10 +1,13 @@ +--- blank_issues_enabled: true contact_links: - name: Discuss proposals url: https://groups.google.com/g/elixir-lang-core - about: Send proposals for new ideas in the mailing list - - name: Ask questions + about: Send proposals for new ideas to our mailing list + - name: Ask questions. Guidance. Support url: https://elixirforum.com/ - about: Ask and answer questions on ElixirForum - + about: > + Ask and answer questions on Elixir Forum. + Ask for guidance or support. + Share your thoughts about the language. diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 68e4023588d..3eff95cc398 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,18 +1,32 @@ +--- name: Report an issue -description: Tell us about something that's not working the way we (probably) intend +description: + Tell us about something that is not working the way we (probably) intend. body: - - type: input + - type: markdown + attributes: + value: > + Thank you for contributing to Elixir. + + Please, do not use this form for guidance, questions or support. + Try instead in [Elixir Forum](https://elixirforum.com), + the [IRC Chat](https://web.libera.chat/#elixir), + [Stack Overflow](https://stackoverflow.com/questions/tagged/elixir), + [Slack](https://elixir-slackin.herokuapp.com), + [Discord](https://discord.gg/elixir) or in other online communities. + + - type: textarea id: elixir-and-otp-version attributes: label: Elixir and Erlang/OTP versions - description: Paste the output of `elixir -v` here. + description: Paste the output of `elixir --version` here. validations: required: true - type: input id: os attributes: - label: Operating System + label: Operating system description: The operating system that this issue is happening on. validations: required: true @@ -21,11 +35,9 @@ body: id: current-behavior attributes: label: Current behavior - description: Include code samples, errors and stacktraces if appropriate. If reporting a bug, please include the reproducing steps. - placeholder: |- - 1. foo - 2. bar - 3. baz + description: > + Include code samples, errors and stacktraces if appropriate. + If reporting a bug, please include the reproducing steps. validations: required: true @@ -36,3 +48,14 @@ body: description: A short description on how you expect the code to behave. validations: required: true + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: > + By submitting this issue, you agree to follow our + [Code of Conduct](https://github.com/elixir-lang/elixir/blob/main/CODE_OF_CONDUCT.md#code-of-conduct). + options: + - label: I agree to follow this project's Code of Conduct + required: true From 4d63fd2be5a20e83b6725e227e70e4e4e897fa4f Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Fri, 3 Jun 2022 12:52:09 -0500 Subject: [PATCH 2/2] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: José Valim --- .github/ISSUE_TEMPLATE/config.yml | 7 ++----- .github/ISSUE_TEMPLATE/issue.yml | 15 ++------------- 2 files changed, 4 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 30e10de3508..7ea6120cac9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -5,9 +5,6 @@ contact_links: - name: Discuss proposals url: https://groups.google.com/g/elixir-lang-core about: Send proposals for new ideas to our mailing list - - name: Ask questions. Guidance. Support + - name: Ask questions and support url: https://elixirforum.com/ - about: > - Ask and answer questions on Elixir Forum. - Ask for guidance or support. - Share your thoughts about the language. + about: Ask questions, provide support and more on Elixir Forum diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 3eff95cc398..35752362670 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: > - Thank you for contributing to Elixir. + Thank you for contributing to Elixir! :heart: Please, do not use this form for guidance, questions or support. Try instead in [Elixir Forum](https://elixirforum.com), @@ -36,7 +36,7 @@ body: attributes: label: Current behavior description: > - Include code samples, errors and stacktraces if appropriate. + Include code samples, errors, and stacktraces if appropriate. If reporting a bug, please include the reproducing steps. validations: required: true @@ -48,14 +48,3 @@ body: description: A short description on how you expect the code to behave. validations: required: true - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: > - By submitting this issue, you agree to follow our - [Code of Conduct](https://github.com/elixir-lang/elixir/blob/main/CODE_OF_CONDUCT.md#code-of-conduct). - options: - - label: I agree to follow this project's Code of Conduct - required: true