Skip to content

Commit

Permalink
Merge branch 'master' into rule_priority_empty_semantics
Browse files Browse the repository at this point in the history
  • Loading branch information
tzujenchanmbd authored May 23, 2024
2 parents 0d3a8a5 + 94c1a23 commit 63c861d
Show file tree
Hide file tree
Showing 40 changed files with 4,193 additions and 1,408 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
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
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/spec_change.yml
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
14 changes: 5 additions & 9 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 'Close stale issues and PRs'
on:
schedule:
- cron: '0 0 * * *'
- cron: '0 4 * * *'

permissions:
issues: write
Expand All @@ -11,15 +11,11 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v4
- uses: actions/stale@v9.0.0
with:
stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
close-issue-message: 'This issue has been closed due to inactivity. Issues can always be reopened after they have been closed.'
stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It may be closed manually after one month of inactivity. Thank you for your contributions.'
stale-issue-label: 'stale'
days-before-issue-stale: 365
days-before-issue-close: 14
stale-pr-message: 'This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
close-pr-message: 'This pull request has been closed due to inactivity. Pull requests can always be reopened after they have been closed. See the Specification Amendment Process.'
stale-pr-message: 'This pull request has been automatically marked as stale because it has not had recent activity. It may be closed manually after one month of inactivity. Thank you for your contributions.'
stale-pr-label: 'stale'
days-before-pr-stale: 23
days-before-pr-close: 7
days-before-pr-stale: 90
4 changes: 1 addition & 3 deletions gtfs-realtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ This directory contains GTFS Realtime Specification and documentation.

### Quick links
- [GTFS Realtime protocol buffer definition](proto/gtfs-realtime.proto)
- Documentation
- [English](spec/en)
- [Español](spec/es)
- [Spec Realtime Reference](spec/en/reference.md)
- [How to change the specification?](CHANGES.md)

19 changes: 19 additions & 0 deletions gtfs-realtime/best-practices/README.md
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
Loading

0 comments on commit 63c861d

Please sign in to comment.