Skip to content
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.

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

Add GitHub issue templates #8934

Merged
merged 8 commits into from Mar 9, 2021
Merged

Conversation

j8r
Copy link
Contributor

@j8r j8r commented Mar 24, 2020

Implements a suggestion posted in the forum.

The main goal is to simplify issue creation, and limit questions unrelated directly to the language being posted in the bug tracker by redirecting users to the correct places to post their questions/issues.

I changed the default branch of my fork to have a preview: https://github.com/j8r/crystal/issues/new/choose.

This is a rough starting-point, core members will certainly have better template ideas that fits more the project.

Copy link
Member

@bcardiff bcardiff left a comment

Choose a reason for hiding this comment

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

I like it!

I'm not sure if the language improvement discussion should be encouraged to happen here or in the forum (https://forum.crystal-lang.org/c/crystal-contrib). The motivation would be to aim for actionable issues as much as possible.

Another thing that could be done is split the bug & features regarding std-lib or compiler. Splitting that can help to apply initial labels. But I'm not sure it's worth it.

.github/ISSUE_TEMPLATE/bug-report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.md Outdated Show resolved Hide resolved
Copy link
Member

@straight-shoota straight-shoota left a comment

Choose a reason for hiding this comment

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

This is great!

@bcardiff I might like separation between stdlib and compiler, but it also increases complexity. For a user (especially a novice) it might be difficult to tell where the bug actually originates. So I'd rather leave it combined (at least for now, maybe we get better ideas later).

@j8r I don't see the difference between Language Improvement Discussion and Feature Request. What was your idea for having two separate entries?

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
@j8r
Copy link
Contributor Author

j8r commented Mar 24, 2020

@straight-shoota I was finding an issue category more general, which is usually more about an idea than a real feature proposal.

j8r and others added 5 commits March 24, 2020 19:37
Co-Authored-By: Sijawusz Pur Rahnama <sija@sija.pl>
Co-Authored-By: Sijawusz Pur Rahnama <sija@sija.pl>
Co-Authored-By: Sijawusz Pur Rahnama <sija@sija.pl>
@asterite
Copy link
Member

This is great! I didn't even know this was possible.

@j8r
Copy link
Contributor Author

j8r commented Mar 24, 2020

There is also pull request templates.
It will be a bit less useful than issue templates, but would be definitely a good-to-have.
I can post a PR after this one.

@straight-shoota
Copy link
Member

I just think that it's not clear what exactly distinguishes I want to start a new discussion about improving the language from I want to propose a new language feature. These descriptions have a fair part of overlap.

Also we should probably consider using the expression language or stdlib to make sure it's not only about the language itself.

@j8r
Copy link
Contributor Author

j8r commented Mar 24, 2020

For example, what kind of issue would be "Getting rid of Errno", or any issue related to cleanups/enhancements? That's not really feature proposal.

@j8r
Copy link
Contributor Author

j8r commented Apr 11, 2020

Can we move forward this, what are the core members' suggestion?
Please if you agree on a category, commit it here.

Copy link
Member

@straight-shoota straight-shoota left a comment

Choose a reason for hiding this comment

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

Let's merge this.

Copy link
Member

@sdogruyol sdogruyol left a comment

Choose a reason for hiding this comment

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

IMHO This is great for last User Experience 👍 Thanks @j8r 🙏

@straight-shoota straight-shoota added this to the 1.0.0 milestone Mar 8, 2021
@bcardiff bcardiff merged commit 67e2829 into crystal-lang:master Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants