Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
isabelle-dr authored May 12, 2024
1 parent b18d84a commit e0528e4
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions gtfs-realtime/best-practices/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# GTFS Realtime Best Practices

These are recommended practices for describing real-time public transportation services in the [GTFS Realtime](../spec/en/reference.md) Reference format. These complement the explicit recommendations outlined in the GTFS Realtime Reference using the terms “recommend” or “should”. Although not mandatory, following these best practices can significantly improve the quality of the data and the overall experience for riders.
These are recommended practices for describing real-time public transportation services in the [GTFS Realtime Reference](../spec/en/reference.md) format. These complement the explicit recommendations outlined in the GTFS Realtime Reference using the terms “recommend” or “should”. Although not mandatory, following these best practices can significantly improve the quality of the data and the overall experience for riders.
These practices have been synthesized from the experience of the [GTFS Best Practices working group members](https://gtfs.org/schedule/best-practices/#gtfs-best-practices-working-group) and application-specific GTFS practice recommendations. See the [FAQ](https://gtfs.org/schedule/best-practices/#frequently-asked-questions-faq) for more information.

⚠️ **NOTE: The Best Practices are in the process of being merged into the [spec](../spec/).
You can find more information about this in [issue #421](https://github.com/google/transit/issues/421).
If you'd like to suggest a new best practice, [open an issue](https://github.com/google/transit/issues/new/choose) or create a Pull Request on the [spec](../spec/).** ⚠️
---
⚠️ **NOTE: The GTFS Realtime Best Practices are in the process of being merged into the [GTFS Realtime Reference](../spec/) (see [issue #396](https://github.com/google/transit/issues/396) and [issue #451](https://github.com/google/transit/issues/451) for more information).**
**New Best Practices will be added directly to the GTFS Realtime Reference. If you'd like to suggest a new Best practice, you can:**
- **look at the existing [list of outstanding issues and PRs](https://github.com/google/transit/issues/421). If your new Best Practice idea is referenced on this list, comment on the issue**
- **[open a new issue](https://github.com/google/transit/issues/new/choose)**
- **open a Pull Request following the [Spec Amendment Process](https://gtfs.org/realtime/process/).**
---

## Documentation Structure

Expand Down

0 comments on commit e0528e4

Please sign in to comment.