Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 5.2 KB

CONTRIBUTING.md

File metadata and controls

55 lines (31 loc) · 5.2 KB

Contributor Guidelines

The Open Mobility Foundation is a free and open-source software foundation that manages the Mobility Data Specification (MDS) and the Curb Data Specification (CDS). These guidelines will help you understand how to to contribute and what is involved.

Who can contribute

MDS and CDS are open specifications and anyone can contribute to their development. Because these specifications are intended to support a growing ecosystem of mobility services, policies, and tools, there are some key stakeholders whose participation is particularly encouraged:

  • Public agencies: As licensing authority and regulator, public agencies are the ultimate customers for MDS and CDS and the data flowing through them. The public agency role is to ensure that MDS and CDS effectively support program management and offers a flexible foundation for policy implementation. Public agencies of all levels of technical capacity are encourage to participate in the evolution of MDS adn CDS, whether by submitting pull requests and issues, or simply by providing feedback during release cycles.

  • Mobility service and logistics providers: Providers are often required to implement MDS or CDS in order to comply with permitting requirements for their services. Providers can inform the development of MDS and CDS with real-world operating experience and to offer input on specification design that maximizes data quality, reliability, and utility.

  • Public agency software partners: Serve as a key bridge between public agencies and mobility and logistics service providers by offering tools that turn MDS adn CDS data into useful insights. The public agency software partners help ensure that MDS and CDS will enable real-world product development, reflects the needs of their public agency customers, and encourages private investment in the MDS and CDS ecosystems.

Community Profile

Contributions can come from many places, including individuals, companies, non-profits, and governments, and work is done both online and via regular video conference calls. As such we want to make this community welcoming and ensure participants know a little about the people contributing and ensure transparency. To that end, we recommend every contributor has an up to date Github Profile, including:

  • Name
  • Bio
  • Company/Organization/City
  • Location
  • Profile Picture
  • Website Link
  • Social Media Links

See this profile for an example of the kinds of information you can add to your profile.

How to contribute

Contributions should be offered through GitHub issues and pull requests. Please review the Release Guidelines for details on the release process, schedule, and communications channels.

In general, you may open an issue or make a pull request at any time. Once the issue or pull request is associated with a particular Milestone, it will be included for review within the process for that release.

All contributors must agree to the Open Mobility Foundation's Individual Contributor License Agreement (ICLA) and Participation Policies. Pull requests will not be merged without a signed ICLA. If a contributor is working on behalf of a company or other organization, that organization must also agree to the Entity Contributor License Agreement (ECLA). These agreements clarify the intellectual property status of work that is contributed to OMF projects. They apply to all contributions, including source code, documentation, and comments.

What belongs in MDS

MDS is a tool to facilitate data exchange between mobility service providers, public agencies, and public agency software partners. Although providers are often required to support MDS as part of mobility permits or policies, MDS is intended as a neutral mechanism for information exchange. It is not intended to force or foreclose any specific policy options that a public agency may choose to pursue.

MDS is built as an interface between local governments and mobility service providers. Access to MDS APIs should be restricted, and is not intended to directly support public consumption or consumer-facing applications.

What belongs in CDS

CDS is a tool to digitally express curbside regulations and curb utilization data in a form that is useful and equitably accessible to curb zone users and customizable for cities.

CDS is built as an interface between local governments, commercial curb users and the public. CDS APIs are intended to directly support public consumption and consumer-facing applications and access should not be restricted.

Release Process

MDS and CDS are evolving specifications with regular release cycles. Please review the Release Guidelines to understand the release process.

Participation Policies and Code of Conduct

See our CODE OF CONDUCT page.