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

Bug report template improvements #3069

Conversation

mdesantis
Copy link
Contributor

@mdesantis mdesantis commented Feb 1, 2019

It includes the following changes:

  1. Remove the **Describe the bug** title: since it is a title and not a HTML comment, it encourages the user to start the bug report content with Describe the bug

  2. On reproduction steps, suggest using the Solidus sandbox, which helps in order to have a deterministic way to reproduce the bug

  3. Add "Current behavior" section, otherwise it would get lost into the reproduction steps and "Expected behavior" wouldn't have a counterpart section

Checklist:

  • Pull Request guidelines are respected
  • Documentation/Readme have been updated accordingly
  • Changes are covered by tests (if possible)
  • Each commit has a meaningful message attached that described WHAT changed, and WHY

Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

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

❤️

Copy link
Contributor

@aitbw aitbw left a comment

Choose a reason for hiding this comment

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

👏

It includes the following changes:

1. Remove the `**Describe the bug**` title: since it is a title and not
a HTML comment, it encourages the user to start the bug report content
with `**Describe the bug**`

2. On reproduction steps, suggest using the Solidus sandbox, which helps
in order to have a deterministic way to reproduce the bug

3. Add "Current behavior" section, otherwise it would get lost into the
reproduction steps and "Expected behavior" wouldn't have a counterpart
section
@mdesantis mdesantis force-pushed the solidus-bug-report-template-improvements branch from 52efb05 to 1178fcd Compare February 1, 2019 16:41
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

Thanks @mdesantis 👏

@kennyadsl kennyadsl merged commit f448dba into solidusio:master Feb 3, 2019
@mdesantis mdesantis deleted the solidus-bug-report-template-improvements branch April 1, 2019 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants