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

Add Best Practices source documentation in the google/transit repo #447

Merged
merged 13 commits into from
May 12, 2024

Conversation

isabelle-dr
Copy link
Collaborator

@isabelle-dr isabelle-dr commented Apr 25, 2024

Context

MobilityData is in the process of consolidating the GTFS Schedule Best Practices and the GTFS Realtime Best Practices with the GTFS Schedule and Realtime specs that are part of this repo, because both serve as reference documentation that we aim to promote adherence to.

As part of this effort:

  • all new Best Practices will be added directly into the spec.
  • we are migrating some of the Best Practices based on their level of adoption and community consensus
    • phasing plan for migrating the GTFS Schedule Best Practices.
    • phasing plan for migrating the GTFS Realtime Best Practices.
  • we've migrated issues and PRs that were still relevant from the Best Practice repos into this repo (list of issues here).
  • we might work on restructuring the spec to smoothly incorporate Best Practices without adding complexity.

Included in this PR

This PR adds the Best Practice documentation into this repo to consolidate the reference documentation in this repo, and give the Best Practices more visibility.
I've also consolidated the GTFS Realtime Best Practices into one single document so it's easier to read.

When they are merged here, we will archive the Best Practice repositories.
We will leave this PR open for 10 working days, until May 9 end of day. If no opposition is expressed, we will merge it.

@isabelle-dr isabelle-dr requested a review from Sergiodero April 25, 2024 12:34
@eliasmbd eliasmbd added Change: Editorial Inconsequential changes to the specification such as link updates, grammatical errors, formatting. Support: Needs Review Needs support to review proposal. labels May 1, 2024
Copy link
Collaborator

@Sergiodero Sergiodero left a comment

Choose a reason for hiding this comment

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

Changes LGTM after a quick review! @isabelle-dr

@isabelle-dr
Copy link
Collaborator Author

Merging this PR, thanks for the review @Sergiodero!

As a result, we will:

@isabelle-dr isabelle-dr merged commit 08323db into google:master May 12, 2024
2 checks passed
@eliasmbd eliasmbd added GTFS Schedule Issues and Pull Requests that focus on GTFS Schedule GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime labels May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Change: Editorial Inconsequential changes to the specification such as link updates, grammatical errors, formatting. GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime GTFS Schedule Issues and Pull Requests that focus on GTFS Schedule Support: Needs Review Needs support to review proposal.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants