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

Introduce GitHub issue template for reporting a bug #223

Merged
merged 7 commits into from
Sep 25, 2022

Conversation

japborst
Copy link
Member

@japborst japborst commented Sep 6, 2022

No description provided.

@japborst japborst requested a review from rickie September 6, 2022 07:50
@rickie rickie added the documentation A documentation update label Sep 6, 2022
@rickie rickie added this to the 0.2.1 milestone Sep 6, 2022
Copy link
Member

@rickie rickie left a comment

Choose a reason for hiding this comment

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

Some suggestions, the rest looks good to me!

.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
@rickie
Copy link
Member

rickie commented Sep 6, 2022

Suggested commit message:

Introduce GitHub issue template for reporting a bug (#223)

We could decide to drop GitHub and/or change the last two words.

@rickie rickie requested a review from Stephan202 September 7, 2022 06:07
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
@rickie rickie force-pushed the japborst/issue-bug-template branch from b3708ce to 77ec08d Compare September 10, 2022 12:58
@rickie rickie modified the milestones: 0.3.0, 0.4.0 Sep 19, 2022
@japborst japborst force-pushed the japborst/issue-bug-template branch from a47b2bc to e686b3b Compare September 23, 2022 07:57
@Stephan202 Stephan202 force-pushed the japborst/issue-bug-template branch from d02025d to ab8d97b Compare September 25, 2022 08:10
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

I rebased and added a commit with some extra details. I also simplified some of the sentences (avoiding "implicit words"), as that might make the template more accessible to non-native speakers.

Once we make the repo public we could perhaps also try the issue forms beta

@japborst
Copy link
Member Author

Super, thanks @Stephan202.

The good thing of the issue forms are that they are quite rigid, the bad thing is that they are ... quite rigid. Let's start with the current template to verify if this setup works for our users.

@japborst japborst changed the title Introduce bug issue template Introduce GitHub issue template for reporting a bug Sep 25, 2022
@japborst japborst merged commit 7f18bd9 into master Sep 25, 2022
@japborst japborst deleted the japborst/issue-bug-template branch September 25, 2022 09:26
@japborst
Copy link
Member Author

Confirming that this indeed works as expected.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A documentation update
Development

Successfully merging this pull request may close these issues.

3 participants