Skip to content

Commit f61d10f

Browse files
authored
Update on Code webpage to archive outdated information and guide newcomers (#484)
* Update CONTRIBUTING.md * Create archive * Revert "Create archive" This reverts commit 0f56c4e. * 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 b751c07. * Update README.md * Update README.md
1 parent 4080084 commit f61d10f

File tree

4 files changed

+47
-18
lines changed

4 files changed

+47
-18
lines changed

CONTRIBUTING.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
1-
Want to contribute? Great! First, read this page (including the small print at the end).
1+
# Join the Community
22

3-
### Before you contribute
3+
- Visit [__GTFS.org__](https://gtfs.org/) the official GTFS documentation website.
4+
- Join [__Slack__](https://share.mobilitydata.org/slack) and introduce yourself to the community.
5+
- Subscribe to the [__GTFS Digest__](https://groups.google.com/g/gtfs-digest) for monthly updates about all things GTFS.
6+
- 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.
7+
8+
# GTFS Governance
9+
10+
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.
11+
12+
To formalize this process, we've established the GTFS Governance framework, which includes the Specification Amendment Process.
13+
14+
- [GTFS Schedule - Specification Amendment Process](https://github.com/google/transit/blob/master/gtfs/CHANGES.md)
15+
16+
- [GTFS Realtime - Specification Amendment Process](https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md)
17+
18+
## Before you contribute
419
Before we can use your code, you must sign the
520
[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
6-
(CLA), which you can do online. The CLA is necessary mainly because you own the
21+
(CLA), which you can do online.
22+
23+
The CLA is necessary mainly because you own the
724
copyright to your changes, even after your contribution becomes part of our
825
codebase, so we need your permission to use and distribute your code. We also
926
need to be sure of various other things—for instance that you'll tell us if you
10-
know that your code infringes on other people's patents. You don't have to sign
11-
the CLA until after you've submitted your code for review and a member has
12-
approved it, but you must do it before we can put your code into our codebase.
13-
Before you start working on a larger contribution, you should get in touch with
14-
us first through the issue tracker with your idea so that we can help out and
27+
@@ -15,10 +32,6 @@ us first through the issue tracker with your idea so that we can help out and
1528
possibly guide you. Coordinating up front makes it much easier to avoid
1629
frustration later on.
1730

18-
### Code reviews
19-
All submissions, including submissions by project members, require review. We
20-
use Github pull requests for this purpose.
21-
2231
### The small print
2332
Contributions made by corporations are covered by a different agreement than
2433
the one above, the
25-
[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).

README.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1-
The repository contains specification to manipulate General Transit
2-
Feed Specification (GTFS) and GTFS Realtime:
3-
* [GTFS](/gtfs/README.md)
4-
* [GTFS Realtime](/gtfs-realtime/README.md)
1+
# General Transit Feed Specification (GTFS)
2+
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.
53

6-
Please visit https://gtfs.org for information.
4+
[Read more about GTFS](https://gtfs.org/)
5+
6+
## Get Monthly Updates on GTFS Developments
7+
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.
8+
9+
### **🔔 [Subscribe to the GTFS Digest](https://groups.google.com/g/gtfs-updates)**
10+
11+
GTFS relies on community contributions. Please help us capture GTFS developments by sharing your updates for our next digest to: [[email protected]](mailto:[email protected])
12+
13+
## Useful Resources
14+
### Getting Started with GTFS
15+
- Visit [GTFS.org](https://gtfs.org/) to learn more about GTFS
16+
- An overview of [GTFS Schedule](https://gtfs.org/schedule/)
17+
- An overview of [GTFS Realtime](https://gtfs.org/realtime/)
18+
19+
### Contribute to GTFS and join the Community
20+
21+
- [Learn how you can contribute to GTFS Development](https://github.com/google/transit/blob/master/CONTRIBUTING.md)
22+
- Join [__Slack__](https://share.mobilitydata.org/slack) and introduce yourself to the community.
23+
- 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.
24+
25+
26+
### What is GitHub?
27+
* [Getting Started with GitHub](https://docs.github.com/en/get-started)

AUTHORS archive/AUTHORS

File renamed without changes.

CONTRIBUTORS archive/CONTRIBUTORS

File renamed without changes.

0 commit comments

Comments
 (0)