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

Improve text describing "corrupted sources" in acceptance test results #1087

Open
barbeau opened this issue Jan 11, 2022 · 0 comments
Open
Labels
enhancement New feature request or improvement on an existing feature status: Needs discussion We need a discussion on requirements before calling this issue ready tests Anything related to our tests.

Comments

@barbeau
Copy link
Member

barbeau commented Jan 11, 2022

Feature request

PR #848 implemented the acceptance test mechanism where new contributions are tested against a large number of existing GTFS datasets to see if they introduce new errors. Which is awesome! 🎉

A suggestion - I think the wording of the comment could be improved to make it more easily understandable to contributors.

Currently, as shown in #848 (comment), the text says:

Thank you for this contribution! 🍰✨🦄

Information about source corruption
0 out of 1248 sources are corrupted.

Acceptance test details
The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 2d320f2 here (report will disappear after 90 days).

For new contributors, this raises questions like:

  • What are these sources, and why could they be corrupted?
  • If there are "corrupted sources", am I supposed to do something about it?

Proposed solution
Here is some proposed text that I think is easier to understand. It's a starting point, so please feel free to edit:

Thank you for this contribution! 🍰✨🦄

Acceptance test details

The changes in this pull request were successfully tested against 1248 of 1248 real-world GTFS datasets from the MobilityDatabase and no new errors were triggered.

Download the full acceptance test report for commit 2d320f2 here (report will disappear after 90 days).

Alternately, for corrupted sources:

Thank you for this contribution! 🍰✨🦄

Acceptance test details

The changes in this pull request were successfully tested against 1200 of 1248 real-world GTFS datasets from the MobilityDatabase and no new errors were triggered. 48 GTFS datasets were corrupted and could not be tested.

Describe alternatives you've considered
Do nothing - stick with the same text and explain the comment to anyone who asks about it.

@barbeau barbeau added the enhancement New feature request or improvement on an existing feature label Jan 11, 2022
@isabelle-dr isabelle-dr added this to the v3.3.0 - acceptance test improvements milestone Jan 11, 2022
@isabelle-dr isabelle-dr added tests Anything related to our tests. status: Needs discussion We need a discussion on requirements before calling this issue ready labels Oct 3, 2022
@isabelle-dr isabelle-dr removed this from the Acceptance test improvements milestone Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature request or improvement on an existing feature status: Needs discussion We need a discussion on requirements before calling this issue ready tests Anything related to our tests.
Projects
None yet
Development

No branches or pull requests

2 participants