Skip to content
This repository has been archived by the owner on Aug 17, 2023. It is now read-only.

Latest commit

 

History

History
53 lines (27 loc) · 3.18 KB

CONTRIBUTING_EN.md

File metadata and controls

53 lines (27 loc) · 3.18 KB

Contributing to TPP

Read this in other languages: Português

👍 🎉 First of all, a big thanks for your contribution with your time! 🎉 👍

If you have not yet joined our Gitter communication channel, you can do it here!

We want you to develop design features that excites you.!!!

If you get stuck at any point, you're welcome to create an Issue on GitHub.

All members of our community are required to follow our code of conduct. Make sure you are warm and friendly in all our spaces.

Here are some important resources for beginners:

Contribute to the development

If you want to dive deep and help with the development of TPP, install the project locally first according to our [Installation Guide] (https://github.com/tpportugal/tpp/blob/master/README.md). After that, we suggest you check the Issues on our [Issue Tracker] (https://github.com/tpportugal/tpp/issues) that are marked as' Good First Issue`. These issues are great for a smooth start and do not put you in front of the more complex parts of the system.

If you want to work on more challenging tasks, then follow the following markers: data, feature, bug. These issues have an overview and description of the intended. These kinds of Issues will be the ideal ones to start. That being said, these are not necessarily the easiest Issues.

Testing

In order to ensure the functionality of the application, it is important to run several tests in the software to eliminate the possibility of logical errors.

  • Each service will have a markdown file TESTING.md in their repository to explain how to test the service.

  • Make sure the feature really solves the problem in question.

Coding style

  • Each service will have a markdown file STYLING.md in their repository to explain how to follow the coding style of the project.

Introduction of your data in AUTHORS.md

If it is your first commit in any repository, add your name and contact in the AUTHORS.md

Contribute to data collection

With hundreds of public transport operators, we will also need your help in collecting data. Make sure the data collected is available to the public.

To contribute with timetables in format (PDF or JPG) you can access this link and fill out the form: https://www.tpp.pt/upload

Obtaining data from operators in GTFS format

It is necessary to have a specification of data so that the integration and the maintenance of the data are efficient. You can read the document posted by Google on this link

Not all companies, unfortunately, adhere to the idealism of Open-Data, this implies that there are bureaucracies in obtaining data. If you would like to contact the transport operators, please speak to one of the administrators: glaand (André Glatzl), Rui-Santos (Rui J Santos), VitorSantos1 (Vítor Santos).