GSoC 2023 Guidelines

In the following sections, we'd like to describe a bit better what we expect from applicants and what applicants can expect from us (and what not). Anyone wanting to engage with our project for GSoC 2023 should read and follow this document carefully.

The project

This project will be a GSoC first-timer. The final goal is well enough described in the project description at OSM GSoC.

Ideally the successful candidate is able to commit to the full 350 hours, so that we have the final OSRM Python package available on PyPI for all major platforms and distributions/OS versions.

You can contact us to express your interest in the associated issue: https://github.com/Project-OSRM/osrm-backend/issues/6558, and we'll take further communication from there.

The process

Officially the application period for GSoC will start on 20.03.2023. However, we understand and appreciate that you don't want to wait that long to get your hands dirty. We'd ask you to follow the following:

1. Learn about OpenStreetMap as a whole. Create an account and do some mapping in your local area. Specifically focus on roads and their attributes. After all, this is a routing project.
2. Get to know the OSRM project by building it locally (no Docker!), set up your development environment in either CLion or VS Code and use the available documentation to build a graph for your favorite city or region.
3. Tackle one open issue or, even better, create an issue yourself with stuff you think would be great to have, such as improving documentation . Clearly state that you want to fix the open issue and we'll assign you. If we don't hear anything from you in 3 days, you'll be unassigned and it's given to the next candidate. Also, see Rule 1 and Rule 2.
4. Let us know when you think your PR is ready for review. This is a critical point for us, as it shows how you did what without our intervention.
5. If you're still there, congrats! Though that's not the final pass to being selected. You'll still have to write the full project proposal. We recommend handing in the proposal as early as possible so there's enough time smoothen out the rough edges. Plan realistically: there's only around 10 weeks and it's at minimum a 50% job.

The rules

You, a student or someone else with a lot of time, want to know how you could wiggle your way into this GSoC project. Good on you!

However, do note, this is open source and as most open source projects, it's entirely run by volunteers who sacrifice their time unpaid. Thus we have some rules, mostly to protect ourselves. So be nice!

Rule 1: Leave us alone!

We’re a small voluntary team with plenty of work to do already. So really, really don’t waste our time asking silly questions. This is not school. Go through the usual checklist and be your own troubleshooter. That inner monologue is actually part of the learning process.

Then, if you are still stuck, do ask, and clearly show what you tried. "XY is not working, need help!" will not get you anywhere.

During the pre-selection period, i.e. until the end of point 3 in the process, we won't engage much with you. We expect you know how to help yourself, it's part of the selection process for us.

Rule 2: Don't be fancy!

If open source was a phone, we prefer the Nokia 6210 (yes, we're that old!) over the newest iPhone. The former will still run on the first battery charge after the latter's screen had to be replaced 4 times. Low maintenance is the goal. Internalize that. Be simple, do what everyone actually needs: fix bugs, improve coverage, increase efficiency. Make us happy.

That’s it!

Applications run 20.03. – 04.04.2023, but the real time to start working is now. Selections will be announced on May 4th.

Good luck!

Acknowledgements

Thanks for the inspiration by Lonvia's GSoC Announcement and Kiwix.