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

review: adding issue templates #64

Merged
merged 13 commits into from
Dec 19, 2023
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
emmambd marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Slack channel
url: https://share.mobilitydata.org/slack
about: Join the gtfs channel to discuss with other community members, and receive updates.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/extension_proposal.yml

Choose a reason for hiding this comment

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

I think we could potentially add an "alternatives considered" section.

emmambd marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Extension proposal
description: Propose a major change to the spec. Examples of extension proposal include [GTFS-Fares v2](https://gtfs.org/extensions/fares-v2/) or [GTFS-TripModifications](https://github.com/google/transit/issues/369).
labels: ['extension-proposal']

body:
- type: markdown
attributes:
value: >
#### Before submitting a new extension proposal, please make sure there isn't an already [existing extension proposal](https://gtfs.org/extensions/).
- type: textarea
attributes:
label: Describe the problem
description: >
Describe what you are trying to achieve, and how the spec is making it difficult.
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.
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
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_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Spec improvement
description: Propose an update to the existing spec, such as clarifying descriptions or adding new fields.
emmambd marked this conversation as resolved.
Show resolved Hide resolved
labels: ['improvement']

body:
- type: markdown
attributes:
value: >
#### Before submitting a spec improvement, please make sure there isn't an already [existing issue](https://github.com/google/transit/issues?q=+is%3Aissue+label%3Aimprovement).
- type: textarea
attributes:
label: Describe the problem
description: >
Describe what you are trying to achieve, and how the spec is making it difficult. Describe any other means you currently use to get the job done or to have the information you need.
validations:
required: true
- type: textarea
attributes:
label: Use cases
description: >
Share examples of scenarios you want the improvement to address. [Here's a great example of communicating a complex use case](https://github.com/google/transit/pull/352#issuecomment-1284756181).
emmambd marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: >
A clear description of what you want to happen that includes the GTFS files and fields affected.
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: >
Additional information that can help the community better understand your need.
validations:
required: false
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
MobilityData's internal fork of the Official GTFS Specification repository. This fork is used to draft pull requests before sharing them on the official repo. [Go to the official repo to ask questions and open issues](https://github.com/google/transit).

The repository contains specification to manipulate General Transit
Feed Specification (GTFS) and GTFS Realtime:
* [GTFS](/gtfs/README.md)
Expand Down
33 changes: 31 additions & 2 deletions gtfs-realtime/proto/gtfs-realtime.proto
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ message Alert {
// Entities whose users we should notify of this alert.
repeated EntitySelector informed_entity = 5;

// Cause of this alert.
// Cause of this alert. If cause_detail is included, then Cause must also be included.
enum Cause {
UNKNOWN_CAUSE = 1;
OTHER_CAUSE = 2; // Not machine-representable.
Expand All @@ -600,7 +600,7 @@ message Alert {
}
optional Cause cause = 6 [default = UNKNOWN_CAUSE];

// What is the effect of this problem on the affected entity.
// What is the effect of this problem on the affected entity. If effect_detail is included, then Effect must also be included.
enum Effect {
NO_SERVICE = 1;
REDUCED_SERVICE = 2;
Expand Down Expand Up @@ -656,6 +656,15 @@ message Alert {
// or the user can't see the image for accessibility reasons). See the HTML spec for alt image text - https://html.spec.whatwg.org/#alt.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString image_alternative_text = 16;


// Description of the cause of the alert that allows for agency-specific language; more specific than the Cause. If cause_detail is included, then Cause must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString cause_detail = 17;

// Description of the effect of the alert that allows for agency-specific language; more specific than the Effect. If effect_detail is included, then Effect must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString effect_detail = 18;

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features
Expand Down Expand Up @@ -843,6 +852,26 @@ message VehicleDescriptor {
// The license plate of the vehicle.
optional string license_plate = 3;

enum WheelchairAccessible {
// The trip doesn't have information about wheelchair accessibility.
// This is the **default** behavior. If the static GTFS contains a
// _wheelchair_accessible_ value, it won't be overwritten.
NO_VALUE = 0;

// The trip has no accessibility value present.
// This value will overwrite the value from the GTFS.
UNKNOWN = 1;

// The trip is wheelchair accessible.
// This value will overwrite the value from the GTFS.
WHEELCHAIR_ACCESSIBLE = 2;

// The trip is **not** wheelchair accessible.
// This value will overwrite the value from the GTFS.
WHEELCHAIR_INACCESSIBLE = 3;
}
optional WheelchairAccessible wheelchair_accessible = 4 [default = NO_VALUE];

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
// modifications to the spec.
Expand Down
22 changes: 20 additions & 2 deletions gtfs-realtime/spec/en/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Fields labeled as **experimental** are subject to change and not yet formally ad
* [TripDescriptor](#message-tripdescriptor)
* [ScheduleRelationship](#enum-schedulerelationship-1)
* [VehicleDescriptor](#message-vehicledescriptor)
* [WheelchairAccessible](#enum-wheelchairaccessible)
* [StopTimeUpdate](#message-stoptimeupdate)
* [StopTimeEvent](#message-stoptimeevent)
* [ScheduleRelationship](#enum-schedulerelationship)
Expand All @@ -55,6 +56,7 @@ Fields labeled as **experimental** are subject to change and not yet formally ad
* [TripDescriptor](#message-tripdescriptor)
* [ScheduleRelationship](#enum-schedulerelationship-1)
* [VehicleDescriptor](#message-vehicledescriptor)
* [WheelchairAccessible](#enum-wheelchairaccessible)
* [Position](#message-position)
* [VehicleStopStatus](#enum-vehiclestopstatus)
* [CongestionLevel](#enum-congestionlevel)
Expand Down Expand Up @@ -328,8 +330,10 @@ An alert, indicating some sort of incident in the public transit network.
|------------------|------------|----------------|-------------------|-------------------|
| **active_period** | [TimeRange](#message-timerange) | Optional | Many | Time when the alert should be shown to the user. If missing, the alert will be shown as long as it appears in the feed. If multiple ranges are given, the alert will be shown during all of them. |
| **informed_entity** | [EntitySelector](#message-entityselector) | Required | Many | Entities whose users we should notify of this alert. At least one informed_entity must be provided. |
| **cause** | [Cause](#enum-cause) | Optional | One |
| **effect** | [Effect](#enum-effect) | Optional | One |
| **cause** | [Cause](#enum-cause) | Conditionally Required | One | If cause_detail is included, then Cause must also be included.
| **cause_detail** | [TranslatedString](#message-translatedstring) | Optional | One | Description of the cause of the alert that allows for agency-specific language; more specific than the Cause. If cause_detail is included, then Cause must also be included. <br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.
| **effect** | [Effect](#enum-effect) | Conditionally Required | One | If effect_detail is included, then Effect must also be included.
| **effect_detail** | [TranslatedString](#message-translatedstring) | Optional | One | Description of the effect of the alert that allows for agency-specific language; more specific than the Effect. If effect_detail is included, then Effect must also be included. <br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.
| **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. |
| **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. |
| **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. |
Expand Down Expand Up @@ -474,6 +478,20 @@ Identification information for the vehicle performing the trip.
| **id** | [string](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | Internal system identification of the vehicle. Should be **unique** per vehicle, and is used for tracking the vehicle as it proceeds through the system. This id should not be made visible to the end-user; for that purpose use the **label** field |
| **label** | [string](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | User visible label, i.e., something that must be shown to the passenger to help identify the correct vehicle. |
| **license_plate** | [string](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | The license plate of the vehicle. |
| **wheelchair_accessible** | [WheelchairAccessible](#enum-wheelchairaccessible) | Optional | One | If provided, can overwrite the *wheelchair_accessible* value from the static GTFS. |

## _enum_ WheelchairAccessible

If a particuliar trip is accessible to wheelchair. When available, this value should overwrite the _wheelchair_accessible_ value from the static GTFS.

#### Values

| _**Value**_ | _**Comment**_ |
|-------------|---------------|
| **NO_VALUE** | The trip doesn't have information about wheelchair accessibility. This is the **default** behavior. If the static GTFS contains a _wheelchair_accessible_ value, it won't be overwritten. |
| **UNKNOWN** | The trip has no accessibility value present. This value will overwrite the value from the GTFS. |
| **WHEELCHAIR_ACCESSIBLE** | The trip is wheelchair accessible. This value will overwrite the value from the GTFS. |
| **WHEELCHAIR_INACCESSIBLE** | The trip is **not** wheelchair accessible. This value will overwrite the value from the GTFS. |

## _message_ EntitySelector

Expand Down
Loading