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

Moving Realtime Best Practices into the Spec: Phasing Plan #451

Open
isabelle-dr opened this issue May 12, 2024 · 0 comments
Open

Moving Realtime Best Practices into the Spec: Phasing Plan #451

isabelle-dr opened this issue May 12, 2024 · 0 comments
Labels
Change: Best Practice Changes focusing on recommendations for optimal use of the specification. GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations.

Comments

@isabelle-dr
Copy link
Collaborator

Problem

This issue mirrors issue #396 created for merging the Schedule Best Practices into the spec, but the scope here is GTFS Realtime.
MobilityData’s heard several pains from the community about the GTFS best practices and the spec’s SHOULD statements living in two different places:

  • Producers do not always refer to the best practices, and so moving these into the official spec would give the best practices greater visibility and improve data quality for everyone
  • Merging the best practices in the spec would make it easier for regulators to point producers to one place to get the information they need to create their GTFS feeds

Based on this feedback, MobilityData is working on merging the best practices into the official spec, and to point new best practice discussions to https://github.com/google/transit.

Phasing Plan

MobilityData has created a phasing plan to merge the Realtime Best Practices into the spec.
Each phase will include a corresponding PR to remove parts of the Best Practice documentation.
Any community members are welcome to open a PR to merge best practices — the goal of this phasing plan is for everyone to be roughly aligned on steps so anyone can move to action.

Phase # Best Practice section What’s included
1 Feed Publishing & General Practices. Adding them as a new section in the spec, mirroring the similar section in the GTFS Schedule spec
2 Practice recommendations organized by message. Add recommendations to either the file or the field descriptions.
3 Practice recommendations organized by use-case (frequency-based trips) Add to the corresponding spec locations:
  • TripUpdate/StopTimeUpdate/StopTimeEvent
  • TripUpdate/TripDescriptor
  • VehiclePosition/TripDescriptor

Additional context and related issues

@isabelle-dr isabelle-dr added GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime Change: Best Practice Changes focusing on recommendations for optimal use of the specification. labels May 12, 2024
@isabelle-dr isabelle-dr pinned this issue May 12, 2024
@isabelle-dr isabelle-dr added the Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations. label May 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Change: Best Practice Changes focusing on recommendations for optimal use of the specification. GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations.
Projects
None yet
Development

No branches or pull requests

1 participant