Skip to content

Update bug_report.md to remove Expectation section#197

Merged
zackkrida merged 2 commits intomainfrom
remove-expectation-section
Mar 25, 2022
Merged

Update bug_report.md to remove Expectation section#197
zackkrida merged 2 commits intomainfrom
remove-expectation-section

Conversation

@zackkrida
Copy link
Member

Fixes

Fixes #140 by @zackkrida

Description

Removes the Expectation header from the bug report template.

Testing Instructions

View the .md file and confirm the correct appearance.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@zackkrida zackkrida requested a review from a team as a code owner March 23, 2022 21:50
@zackkrida zackkrida requested review from obulat and stacimc March 23, 2022 21:50
@dhruvkb dhruvkb added 📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Mar 23, 2022
Copy link
Collaborator

@stacimc stacimc left a comment

Choose a reason for hiding this comment

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

LGTM! I agree that section tends to be unused or just repeating yourself.

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Looks good, maybe we should add an instruction to describe both the incorrect as well as the correct behaviour in the description itself.

@sarayourfriend
Copy link
Collaborator

Agree with @dhruvkb's suggestion. Especially for people who aren't used to filing bug reports it's not necessarily obvious that it should include the expected behavior, so the description isn't always going to have it.

Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

+1 to additional instructions, but I'm fine jettisoning this section!

@zackkrida
Copy link
Member Author

Added more detail and an example to the 'Description' section.

@zackkrida zackkrida merged commit c0ca4a0 into main Mar 25, 2022
@zackkrida zackkrida deleted the remove-expectation-section branch March 25, 2022 16:26
dhruvkb added a commit that referenced this pull request Feb 20, 2023
Ignore Storybook files in Prettier
dhruvkb pushed a commit that referenced this pull request Apr 14, 2023
Make Wikimedia script download audio in addition to images
Add popularity metric
Stop downloading items with unclear license status
Public domain marks in Wikimedia should be explored more
Update openverse_catalog/dags/provider_api_scripts/wikimedia_commons.py
Distinguish wikimedia_audio provider from wikimedia (image provider)

Signed-off-by: Olga Bulat <obulat@gmail.com>
Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove "Expectation" header from bug report template

5 participants