Skip to content

Commit

Permalink
Revert "Squashed commit of the following:"
Browse files Browse the repository at this point in the history
This reverts commit db2a467.
  • Loading branch information
richfab committed May 17, 2024
1 parent db2a467 commit e9228fd
Show file tree
Hide file tree
Showing 6 changed files with 1,079 additions and 984 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

### Have you read our [FAQ](https://gbfs.org/learn/faq/)? It’s possible your question can be answered there!
### Have you read our [FAQ](https://gbfs.mobilitydata.org/faq)? It’s possible your question can be answered there!

### If you are new to the specification, please introduce yourself (name and organization/link to GBFS). It’s helpful to know who we're chatting with!

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/close_stale_issues.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ jobs:
with:
repo-token: ${{ env.CREDENTIALS }}
operations-per-run: 100
days-before-stale: 60
days-before-close: 30
stale-issue-message: 'This discussion has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.'
days-before-stale: 120
days-before-close: 60
stale-issue-message: 'This discussion has been automatically marked as stale because it has not had recent activity. It will be closed in 60 days if no further activity occurs. Thank you for your contributions.'
stale-issue-label: 'stale'
exempt-pr-labels: 'v3.0'
close-issue-message: 'This discussion has been closed due to inactivity. Discussions can always be reopened after they have been closed.'
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ If you are new to engaging with the community on this repository, firstly welcom
Find a real-world example of the governance in action [here](https://github.com/MobilityData/gbfs/pull/454). For a more in depth look at the change and contribution process, go to [governance.md](https://github.com/MobilityData/gbfs/blob/master/governance.md).

### Project Roadmap
MobiltyData has compiled a [project roadmap](https://portal.productboard.com/26qpteg4wct9px3jts94uqv8/tabs/99-planned) with a list of major features, changes and other work coming up in the near future.
MobiltyData has compiled a [project roadmap](https://github.com/MobilityData/gbfs/wiki/Project-Roadmap) with a list of major features, changes and other work coming up in the near future.

## Current Version *(Recommended)*
| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|:---:|:---:|---|---|---| ---|
| [v3.0](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md) | MAJOR | April 11, 2024 | :white_check_mark:   *Current Version* | [v3.0 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v3.0) | [v3.0 Article](https://mobilitydata.org/how-to-upgrade-to-gbfs-v3-0/) |
| [v2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md) | MINOR | April 5, 2022 | :white_check_mark:   *Current Version* | [v2.3 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v2.3) | |


### Upcoming MAJOR Version
Expand All @@ -59,23 +59,23 @@ Release Candidates will receive *Current Version* status when they have been ful

| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|:---:|:-----:|----------------|----------------------------|----------------------------------------------------------------------------------------|---------------------|
| No current Release Candidate versions | | | | | |
|[v3.0-RC2](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) | MAJOR | November 14, 2023 | ✅ Ready for implementation | [v3.0-RC2 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v3.0-RC2) | [v3.0-RC2 Release Notes](https://github.com/MobilityData/gbfs/releases/tag/v3.0-RC2) |
|[v3.0-RC](https://github.com/MobilityData/gbfs/blob/v3.0-RC/gbfs.md) | MAJOR | March 10, 2023 | ✅ Ready for implementation | [v3.0-RC Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v3.0-RC) | [v3.0-RC Article](https://mobilitydata.org/2023-the-year-of-v3/) |

### Past Version Releases
Past versions with *Supported* status MAY be patched to correct bugs or vulnerabilities but new features will not be introduced.<br />
Past versions with *Deprecated* status will not be patched and their use SHOULD be discontinued.

| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|:---:|:---:|---|---|---|---|
| [v2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md) | MINOR | April 5, 2022 | :white_check_mark: &nbsp; *Supported* | [v2.3 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v2.3) | [v2.3 Release Notes](https://github.com/MobilityData/gbfs/releases/tag/v2.3) |
| [v2.2](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md) | MINOR | March 19, 2021 |:white_check_mark: &nbsp; *Supported* | [v2.2 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v2.2)| [v2.2 Article](https://mobilitydata.org/cities-gbfs-v2-2-is-here-for-you/)
| [v2.1](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md) | MINOR | March 18, 2021 |:white_check_mark: &nbsp; *Supported* | [v2.1 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v2.1)| [v2.1 Article](https://mobilitydata.org/gbfs-now-fully-supports-dockless-systems-%f0%9f%9b%b4%f0%9f%91%8f/)
| [v2.0](https://github.com/MobilityData/gbfs/blob/v2.0/gbfs.md) | MAJOR | March 16, 2020 | :white_check_mark: &nbsp; *Supported* | [v2.0 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v2.0) | [v2.0 Article](https://mobilitydata.org/whats-new-in-gbfs-v2-0-%f0%9f%9a%b2%f0%9f%9b%b4/) |
| [v1.1](https://github.com/MobilityData/gbfs/blob/v1.1/gbfs.md) | MINOR | March 16, 2020 |:white_check_mark: &nbsp; *Supported* | [v1.1 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v1.1) | |
| [v1.0](https://github.com/MobilityData/gbfs/blob/v1.0/gbfs.md) | MAJOR | Prior to October 2019 | :x: &nbsp; *Deprecated* | [v1.0 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v1.0)| |

### Full Version History
The complete GBFS version history is available in the [Release Notes](https://github.com/MobilityData/gbfs/releases).
The complete GBFS version history is available on the [wiki](https://github.com/MobilityData/gbfs/wiki/Complete-Version-History).

## Specification Versioning
To enable the evolution of GBFS, including changes that would otherwise break backwards-compatibility with consuming applications, GBFS uses [semantic versioning](https://semver.org/).
Expand All @@ -94,7 +94,8 @@ Examples of non-breaking changes include:


#### Version Release Cycles - Release Deprecation
See the [Governance](https://github.com/MobilityData/gbfs/blob/master/governance.md#version-release-cycles) for Version Release Cycles.
* There is no strict limitation on the frequency of MAJOR releases, but the GBFS community aims to limit MAJOR releases to no more than one a 12 month period. To limit releases, multiple breaking changes SHOULD be batched together in a single release.
* There is no guideline to limit the number of MINOR releases. MINOR changes may be applied at any time. MINOR changes MAY be batched together in single release or released immediately, based on the needs of the community.
* GBFS documentation will include a list of current and supported MAJOR and MINOR versions. Supported versions SHALL NOT span more than two MAJOR versions. Past versions that are beyond the two most recent MAJOR versions will be deprecated 180 days after the latest MAJOR version becomes official.

## Guiding Principles
Expand Down Expand Up @@ -122,11 +123,11 @@ If you would like to add a system, please fork this repository and submit a pull
--- | :---: | ----
|Country Code | Yes | ISO 3166-1 alpha-2 code designating the country where the system is located. For a list of valid codes [see here](https://en.wikipedia.org/wiki/ISO_3166-1).
| Name | Yes| Name of the mobility system. This MUST match the `name` field in `system_information.json`
Location | Yes| Primary city in which the system is located, followed by the 2-letter state code for US systems. The location name SHOULD be in English if the location has an English name (eg: `Brussels`).
Location | Yes| Primary city in which the system is located followed by country or state.
System ID | Yes | ID for the system. This MUST match the `system_id` field in `system_information.json`.
URL | Yes | URL for the system from the `url` field in `system_information.json`. If the `url` field is not included in `system_information.json` this SHOULD be the primary URL for the system operator.
Auto-Discovery URL | Yes | URL for the system's `gbfs.json` auto-discovery file.
Authentication Info | Conditionally REQUIRED | If authentication is required, this MUST contain a URL to a human-readable page describing how the authentication should be performed and how credentials can be created, or directly contain the public key-value pair to append to the feed URLs.
Authentication Info URL | Conditionally REQUIRED | If authentication is required, this MUST contain a URL to a human-readable page describing how the authentication should be performed and how credentials can be created.

## GBFS JSON Schemas
Complete JSON schemas for each version of GBFS can be found [here](https://github.com/MobilityData/gbfs-json-schema).
Expand Down
Loading

0 comments on commit e9228fd

Please sign in to comment.