search

MobilityData / gtfs-flex

NOTICE: GTFS-Flex has been merged to GTFS. This repo is no longer up-to-date and will deprecated. Consult the google/transit repo for the up-to-date info.
https://github.com/google/transit
Apache License 2.0
119 stars 24 forks source link

Add semantic versioning to repository #45

Closed scmcca closed 3 years ago

scmcca commented 3 years ago

Add semantic versioning to README.md to distinguish the implied versions of the spec and make it easier to navigate.

Suggested description:

Versioning

Semantic versions are established by a git tag in the form of vX.Y where X.Y is the version name. Multiple changes (commits) may be batched into a single new release.

A whole integer increase is used for breaking changes (MAJOR changes). A decimal increase is used for non-breaking changes (MINOR changes or patches).

Breaking changes include:

  • Removing or changing features.

Non-breaking changes include:

  • Adding features.

Tag commits with versions:

scmcca commented 3 years ago

@westontrillium I want to bring this back up for discussion.

Is this something the Flex community would find useful to keep track of previous (and current) implementations? Especially as we are seeing more and more shifting changes to GTFS-Flex?

If not I'll close the issues and PRs related to this (#44, #45, #57).

westontrillium commented 3 years ago

I do think this could be useful as a back-of-the-house indicator, especially when discussing changes between past versions. At the same time, however, it looks like Flex may be entering a phase wherein there are a lot of small changes being pushed to the master (unless we want to accumulate these small changes and then merge all at once eventually), so including semantic versioning could get cumbersome during this time.

At any rate, to avoid confusion, I think that the phrasing "GTFS-Flex" (sans version number) should always implicitly refer to whatever the most current version is in this repo, while version numbers should really only be referenced in the context of discussing versions in relation to one another (e.g. "the language added in v3.3 brings back the definition established in v2.0," etc.). I'd be interested to hear other's thoughts on this though!

scmcca commented 3 years ago

Sounds good to me. Especially:

At any rate, to avoid confusion, I think that the phrasing "GTFS-Flex" (sans version number) should always implicitly refer to whatever the most current version is in this repo, while version numbers should really only be referenced in the context of discussing versions in relation to one another (e.g. "the language added in v3.3 brings back the definition established in v2.0," etc.). I'd be interested to hear other's thoughts on this though!

To review at a later point in time when we have something more stable.