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 Schedule Best Practices into the Spec: Phasing Plan #396

Open
emmambd opened this issue Aug 14, 2023 · 5 comments · Fixed by #386 or #406
Open

Moving Schedule Best Practices into the Spec: Phasing Plan #396

emmambd opened this issue Aug 14, 2023 · 5 comments · Fixed by #386 or #406
Labels
Change: Best Practice Changes focusing on recommendations for optimal use of the specification. GTFS Schedule Issues and Pull Requests that focus on GTFS Schedule Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations.

Comments

@emmambd
Copy link
Collaborator

emmambd commented Aug 14, 2023

Problem

Referenced from #375 and #376:

MobilityData’s heard a number of 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

Phasing Plan

Based on this feedback, MobilityData is interested in working to merge the best practices into the official spec. There’s notable community interest in this based on the successful adoption of a recommended presence in the spec.

We recognize this is a big effort that will require much community discussion, so we want to propose clear phases to this work, suggested below. Each phase will include a corresponding PR on the Best Practices repo to remove the rules that have been added to the spec. 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.

MobilityData commits to updating the Best Practices repo to point new best practice discussion and PRs to https://github.com/google/transit, and add previous Best Practice issues to the spec repository.

Phase # Best practice section What’s included Status
1 Recommended presence (PR #386)
  • Recommended presence
  • Updated presence for universally recommended fields
Adopted ✅
2 Dataset Publishing and General Practices & All Files guidelines
  • Add Dataset Publishing guidelines as new section of the spec, with reference to https://gtfs.org/resources/gtfs/#gtfs-merge-tools instead of merge function in the old transitfeed validator
  • Update spec File Requirements section to include All File guidelines
Adopted ✅
3 Outstanding Practice Recommendations Organized by File All file recommendations unrelated to 
  • specific cases (loop routes, lasso routes, branches)
  • calendar.service_name (requires adopting a new field)
TBD
4 Practice Recommendations Organized by Case TBD
5 Calendar.service_name Adopt calendar.service_name. Will require a producer and consumer to state they’re implementing this. TBD
6 History on Best Practices Working Group Relevant sections of the Best Practices FAQ and About this Document will be added as a new section in https://gtfs.org/schedule/changes/ TBD

Outstanding Questions for Community

Are there phases you’d split up to be more granular? (The File Recommendations in particular come to mind). If so, which best practices may require more discussion or are higher priority?

@emmambd emmambd added Change: Best Practice Changes focusing on recommendations for optimal use of the specification. GTFS Schedule Issues and Pull Requests that focus on GTFS Schedule labels Aug 14, 2023
@emmambd
Copy link
Collaborator Author

emmambd commented Aug 15, 2023

Curious if those who voted for #386 have any feedback on this plan: @gcamp, @markstos, @westontrillium, @derhuerst, @doconnoronca, @NomeQ, @evansiroky, @philip-cline, @bdferris-v2

@NomeQ
Copy link

NomeQ commented Aug 16, 2023

We don't have any strong opinions on the phasing. It looks like a reasonable plan.

@markstos
Copy link
Contributor

I agree with @NomeQ

@e-lo
Copy link

e-lo commented Aug 17, 2023

MobilityData commits to updating the Best Practices repo to point new best practice discussion and PRs to https://github.com/google/transit, and add previous Best Practice issues to the spec repository.

😻

And I really appreciate the thought that went into the phasing plan and the transparency that it provides. Bravo! 🙌

@bdferris-v2
Copy link
Collaborator

Phasing seems reasonable; I don't have strong opinions.

@eliasmbd eliasmbd pinned this issue Dec 8, 2023
@eliasmbd eliasmbd added the Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations. label Jan 9, 2024
@isabelle-dr isabelle-dr changed the title Moving Best Practices into the Spec: Phasing Plan Moving Schedule Best Practices into the Spec: Phasing Plan Feb 15, 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 Schedule Issues and Pull Requests that focus on GTFS Schedule Plan Roadmap of a larger proposal that aggregates multiple specification changes into iterations.
Projects
None yet
6 participants