Skip to content

Improve Github issue template #11902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2022
Merged

Improve Github issue template #11902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
342d5a7
Improve Github issue template
eksperimental Jun 3, 2022
4d63fd2
Apply suggestions from code review
eksperimental Jun 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
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 and support
url: https://elixirforum.com/
about: Ask and answer questions on ElixirForum

about: Ask questions, provide support and more on Elixir Forum
30 changes: 21 additions & 9 deletions .github/ISSUE_TEMPLATE/issue.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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! :heart:

Please, do not use this form for guidance, questions or support.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can force a line break somehow? In any case, it is not a blocker!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe doubling up the new lines. I will look into it.

Copy link
Contributor Author

@eksperimental eksperimental Jun 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josevalim Let's merge this as it is, since i need to see the changes applied in my main branch, it is easier for me that this one gets merged, and then I submit a second PR if this is doable.

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.
Comment on lines +15 to +16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add these links as well? I didn't add them because I wasn't sure if it was OK to promote them

Copy link
Contributor Author

@eksperimental eksperimental Jun 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took them from elixir-lang.org sidebar so considered them sort of (probably semi-) official.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added them just in case 🤷🏻

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh. I see what you mean now in that new PR. Let's see.


- type: textarea
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since elixir --version returns multiple lines, I converted this field into a 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
Expand All @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed this placeholder since it only applies for bugs.

description: >
Include code samples, errors, and stacktraces if appropriate.
If reporting a bug, please include the reproducing steps.
validations:
required: true

Expand Down