From f61d10f097afd4c5efc9d25cc42a18c726799d49 Mon Sep 17 00:00:00 2001 From: Elias Gino Cripotos <130911698+eliasmbd@users.noreply.github.com> Date: Tue, 13 Aug 2024 15:41:14 +0200 Subject: [PATCH] Update on Code webpage to archive outdated information and guide newcomers (#484) * Update CONTRIBUTING.md * Create archive * Revert "Create archive" This reverts commit 0f56c4eaace19197286ed0571022e7d928e47cc8. * Create readme * Rename CONTRIBUTORS to archive/CONTRIBUTORS Contributors can be seen on code page * Rename AUTHORS to archive/AUTHORS Has not been maintained in 9 years. * Revert "Create readme" This reverts commit b751c07c1310872d27918ad11ea0aee5a39c9727. * Update README.md * Update README.md --- CONTRIBUTING.md | 34 +++++++++++++++++----------- README.md | 31 +++++++++++++++++++++---- AUTHORS => archive/AUTHORS | 0 CONTRIBUTORS => archive/CONTRIBUTORS | 0 4 files changed, 47 insertions(+), 18 deletions(-) rename AUTHORS => archive/AUTHORS (100%) rename CONTRIBUTORS => archive/CONTRIBUTORS (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21e4c711b..17b3cfadb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,33 @@ -Want to contribute? Great! First, read this page (including the small print at the end). +# Join the Community -### Before you contribute +- Visit [__GTFS.org__](https://gtfs.org/) the official GTFS documentation website. +- Join [__Slack__](https://share.mobilitydata.org/slack) and introduce yourself to the community. +- Subscribe to the [__GTFS Digest__](https://groups.google.com/g/gtfs-digest) for monthly updates about all things GTFS. +- Join [__GTFS Changes__](https://groups.google.com/g/gtfs-changes) and [__GTFS Realtime__](https://groups.google.com/g/gtfs-realtime) Google Groups to stay informed on development. + +# GTFS Governance + +The GTFS Specification is not set in stone. Instead, it is an open specification developed and maintained by the community of transit agencies, developers, and other stakeholders who use GTFS. It is expected that this community of producers and consumers of GTFS data will have proposals for extending the spec to enable new capabilities. + +To formalize this process, we've established the GTFS Governance framework, which includes the Specification Amendment Process. + +- [GTFS Schedule - Specification Amendment Process](https://github.com/google/transit/blob/master/gtfs/CHANGES.md) + +- [GTFS Realtime - Specification Amendment Process](https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md) + +## Before you contribute Before we can use your code, you must sign the [Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual) -(CLA), which you can do online. The CLA is necessary mainly because you own the +(CLA), which you can do online. + +The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you -know that your code infringes on other people's patents. You don't have to sign -the CLA until after you've submitted your code for review and a member has -approved it, but you must do it before we can put your code into our codebase. -Before you start working on a larger contribution, you should get in touch with -us first through the issue tracker with your idea so that we can help out and + @@ -15,10 +32,6 @@ us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on. -### Code reviews -All submissions, including submissions by project members, require review. We -use Github pull requests for this purpose. - ### The small print Contributions made by corporations are covered by a different agreement than the one above, the -[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate). diff --git a/README.md b/README.md index 33103def5..492289f57 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,27 @@ -The repository contains specification to manipulate General Transit -Feed Specification (GTFS) and GTFS Realtime: -* [GTFS](/gtfs/README.md) -* [GTFS Realtime](/gtfs-realtime/README.md) +# General Transit Feed Specification (GTFS) +The General Transit Feed Specification (GTFS) is an [Open Standard](https://www.interoperablemobility.org/definitions/#open_standard) used to distribute relevant information about transit systems to riders. It allows public transit agencies to publish their transit data in a format that can be consumed by a wide variety of software applications. Today, the GTFS data format is used by thousands of public transport providers.GTFS consists of two formats: GTFS Schedule and GTFS Realtime. -Please visit https://gtfs.org for information. +[Read more about GTFS](https://gtfs.org/) + +## Get Monthly Updates on GTFS Developments +The GTFS Digest is a monthly newsletter by [MobilityData](https://mobilitydata.org/) providing an overview of GTFS developments, discussions within our community, and ways you can get involved in shaping the future of GTFS. + +### **🔔 [Subscribe to the GTFS Digest](https://groups.google.com/g/gtfs-updates)** + +GTFS relies on community contributions. Please help us capture GTFS developments by sharing your updates for our next digest to: [specifications@mobiltydata.org](mailto:specifications@mobiltydata.org) + +## Useful Resources +### Getting Started with GTFS +- Visit [GTFS.org](https://gtfs.org/) to learn more about GTFS + - An overview of [GTFS Schedule](https://gtfs.org/schedule/) + - An overview of [GTFS Realtime](https://gtfs.org/realtime/) + +### Contribute to GTFS and join the Community + +- [Learn how you can contribute to GTFS Development](https://github.com/google/transit/blob/master/CONTRIBUTING.md) +- Join [__Slack__](https://share.mobilitydata.org/slack) and introduce yourself to the community. +- Join [__GTFS Changes__](https://groups.google.com/g/gtfs-changes) and [__GTFS Realtime__](https://groups.google.com/g/gtfs-realtime) Google Groups to stay informed on development. + + +### What is GitHub? +* [Getting Started with GitHub](https://docs.github.com/en/get-started) diff --git a/AUTHORS b/archive/AUTHORS similarity index 100% rename from AUTHORS rename to archive/AUTHORS diff --git a/CONTRIBUTORS b/archive/CONTRIBUTORS similarity index 100% rename from CONTRIBUTORS rename to archive/CONTRIBUTORS