-
Notifications
You must be signed in to change notification settings - Fork 184
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into rule_priority_empty_semantics
- Loading branch information
Showing
40 changed files
with
4,193 additions
and
1,408 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
contact_links: | ||
- name: GTFS Documentation | ||
url: https://gtfs.org/ | ||
about: The official reference for GTFS documentation. | ||
- name: GTFS Changes Mailing List | ||
url: https://groups.google.com/g/gtfs-changes | ||
about: Follow this group to get announcement on votes on the GTFS Schedule specification. | ||
- name: GTFS Realtime Mailing List | ||
url: https://groups.google.com/g/gtfs-realtime | ||
about: This group is the forum for discussing the GTFS Realtime specification, asking questions, and proposing changes. | ||
- name: GTFS Slack Channel | ||
url: https://share.mobilitydata.org/slack | ||
about: Join the gtfs channel to discuss with other community members, and receive updates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Question | ||
description: Ask a question or raise a problem without a proposed solution. | ||
labels: ['question'] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
#### Before submitting a question, please make sure there isn't an already [existing issue for it](https://github.com/google/transit/issues?q=+is%3Aissue+label%3Aquestion+). | ||
- type: textarea | ||
attributes: | ||
label: Introduce yourself | ||
description: > | ||
If you are new to the specification, please introduce yourself (name and organization/link to your GTFS feed)! | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Ask a question | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Specification change | ||
description: Propose a change to the specification. | ||
labels: ['spec-change'] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
#### Before submitting a new change, please make sure the same one isn't already [proposed in an issue](https://github.com/google/transit/issues). | ||
- type: textarea | ||
attributes: | ||
label: Describe the problem | ||
description: > | ||
Describe what you are trying to achieve. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Use cases | ||
description: > | ||
Share examples of the scenarios you want the proposal to address, e.g GTFS-Fares v2 makes it possible to display the cost of a monthly pass. Show visuals of how it will appear to riders where relevant. [Here's a great example of communicating a complex use case](https://github.com/google/transit/pull/352#issuecomment-1284756181). | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Proposed solution | ||
description: > | ||
A clear description of what you want to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: > | ||
Additional information that can help the community better understand your need. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# GTFS Realtime Best Practices | ||
|
||
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 GTFS Realtime Best Practices are in the process of being merged into the [GTFS Realtime Reference](../spec/en/reference.md) (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 [GTFS Realtime Amendment Process](https://gtfs.org/realtime/process/).** | ||
--- | ||
|
||
## Documentation Structure | ||
|
||
The GTFS Realtime Best Practices are written in Markdown and are organized by Message and by use case. | ||
|
||
* `field_name`: The name of the GTFS Realtime field being described | ||
* `recommendations`: An array of the recommendations provided for each field_name |
Oops, something went wrong.