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

Best Practice: feed_info.txt should be provided (WARNING) #877

Closed
e-lo opened this issue Apr 28, 2021 · 5 comments · Fixed by #1197
Closed

Best Practice: feed_info.txt should be provided (WARNING) #877

e-lo opened this issue Apr 28, 2021 · 5 comments · Fixed by #1197
Assignees
Labels
good first issue Good task for newcomers to work on. GTFS Best Practices Used for Adding or changing rules that belong in the GTFS Best Practices

Comments

@e-lo
Copy link

e-lo commented Apr 28, 2021

Lack of feed_info.txt should all trigger a WARNING because the file is required in the GTFS Best Practices.

Should probably mirror or extend MissingRequiredFileNotice to allow for a parameter to indicate SeverityLevel.WARNING

public MissingRequiredFileNotice(String filename) {
super(ImmutableMap.of("filename", filename), SeverityLevel.ERROR);
}

@e-lo e-lo added the new rule label Apr 28, 2021
@scmcca
Copy link

scmcca commented May 4, 2021

Indeed it is recommended for feed_info.txt.

Maybe I'm missing something, but I don't see recommendations for providing the agency.txt or shapes.txt file in the GTFS Best Practices.

@e-lo
Copy link
Author

e-lo commented May 4, 2021

Good call - agency.txt is actually a required file so that should be checked against the spec and shapes.txt inclusion is not a best practice....but should be! (otherwise you are leaving interpretation up to each consuming app).

Updated issue name to be consistent.

@lionel-nj
Copy link
Contributor

agency.txt is actually a required file so that should be checked against the spec

This is the case, @e-lo have you witnessed dataset where agency.txt is missing but the validation report did not flag it?

@e-lo
Copy link
Author

e-lo commented May 4, 2021

This is the case, @e-lo have you witnessed dataset where agency.txt is missing but the validation report did not flag it?

Nope nope! Sorry for false alarm on that one.

@e-lo e-lo changed the title Best Practice: agency.txt, shapes.txt and feed_info.txt should be provided (WARNING) Best Practice: feed_info.txt should be provided (WARNING) May 4, 2021
@aababilov
Copy link
Collaborator

I would introduce a MissingRecommendedFileNotice and also MissingRecommendedFieldNotice with SeverityLevel.WARNING. I generally think that each notice type should have a fixed priority - this is easier to handle in human-readable validation reports and this is easier to setup exceptions for certain feeds that demonstrate errors that we want to skip.

We may add a @Recommended annotation that would work in a similar way to @Required.

@lionel-nj lionel-nj added GTFS Best Practices Used for Adding or changing rules that belong in the GTFS Best Practices and removed new rule labels Jun 16, 2021
@isabelle-dr isabelle-dr modified the milestones: v3.3.0 - rule improvements, Rule improvements Jan 9, 2022
@isabelle-dr isabelle-dr added the good first issue Good task for newcomers to work on. label Jan 9, 2022
@KClough KClough self-assigned this Apr 22, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue Apr 25, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue Apr 25, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue Apr 25, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 6, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 6, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 6, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 6, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 16, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 16, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 18, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 18, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue May 20, 2022
KClough added a commit to JarvusInnovations/gtfs-validator that referenced this issue Jun 29, 2022
maximearmstrong pushed a commit that referenced this issue Jun 29, 2022
* feat: recommended file annotation #877

* feat: recommended file notice

* chore: apply Jarvus copyright
maximearmstrong pushed a commit that referenced this issue Jun 29, 2022
* feat: recommended file annotation #877

* feat: recommended file notice

* chore: apply Jarvus copyright

* feat: apply recommended file notice to feed_info

* docs: Update RULES.md to include feed_info as a recommended file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good task for newcomers to work on. GTFS Best Practices Used for Adding or changing rules that belong in the GTFS Best Practices
Projects
None yet
6 participants