Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 4.04 KB

Contribution guidelines

First, thank you for your interest!

This project is a community effort, and anyone interested in this project can participate.

We value discussions, respect, and openness in our community. All experiences are welcome, regardless of the technical knowledge. We particularly encourage people from underrepresented backgrounds in Open Source to participate.

Ways to contribute

There are many ways to contribute to this project: opening issues with your ideas, talk about it in a publication, joining the conversation on our slack channel, etc.

Contribution type Description
Participate in the community We have a dedicated Slack to discuss everything GTFS.
Share that you're using this project Letting us know if your organization is using this project will lead to more efficient collaboration in the ecosystem, it will help us evaluating if a change affects your organization, and it also makes the contributors happy!
Share your ideas for improving this project We encourage you to open GitHub issues to share your ideas and ask questions. If something is not working as expected or is unclear to you, chances are you’re not the only one.
Spread the word Reference this project in your articles, on your website, or simply mention that you use it. This will help its implementation & improve collaboration in the GTFS ecosystem.
Propose a modification to the GTFS Diff specification You can propose a modification via a Pull Request.

Propose changes via Pull Request

An issue should be opened describing the piece of work proposed and the problems it solves before a Pull Request is open. This lets the community members participate in the design discussion. We recommend that each Pull Request encapsulates one specific new functionality or fix.

We recommend you open the Pull Request even if your work is not completed and have it marked as Draft until it is ready to be reviewed, in order to let the community members participate and help.

To open a Pull Request, please do the following:

Review process

Every new contribution will be reviewed by MobilityData and the French National Access Point.

Before accepting a contribution, the following criteria will be evaluated:

  • Is the change proposed affecting any of the known projects that are based on this validator?
  • Is the change proposed in line with the vision for this project?
  • Would this addition be easy to extend? Is the design consistent with the rest of the project?
  • Do the documentation or examples need to be updated to reflect the change?