RTEMS Summer Of Code
Table of Contents
RTEMS is proud to have in multiple editions of the Google Summer of Code and European Space Agency Summer of Code in Space. We have applied to be a participating organization in Google Summer of Code 2017.
Currently, there has not been an announcement regarding the 2017 edition of the European Space Agency Summer of Code in Space!
Please use this page as a jumping off point for participating in these student programs with RTEMS and ask questions. We want you to be a part of the RTEMS community!
!!! MORE DETAILS BELOW!!!
- Read through all the material on this page.
- Talk to us on IRC (#rtems on freenode.net) or the RTEMS mailing lists.
- If accepted as an organization, students applying to the RTEMS Project will need to fill out an application at Google Summer of Code.
- You will also need to fill in and later update the information found on the RTEMS GSoC 2017 tracking page.
- We also require you build RTEMS, create an application, run it and post the result to the RTEMS mailing list. The GSoC Getting Started page has some more information.
- Pick a project from the list at Open Projects. This is by no means an all inclusive list and we are open to suggestions. Submissions of ports to new architectures, new BSPs, new device drivers, and test improvements are always welcomed.
- Code your heart out and have a great summer!
- Share your knowledge and pledge to help a student.
- Visit the GSoC2015 to register and open a connection with RTEMS Project.
- Update your information at the RTEMS Mentors page.
- Help the student succeed!
General Program Information and Guidance
- Google's Starting Page for the Summer of Code
- GSoC Student Guide - This is a community developed book.
RTEMS Specific Information
- GSoC Getting Started - getting up to speed with RTEMS development for GSoC students.
Be sure to add yourself to the table below.
Writing Proposals and Doing Projects
The RTEMS Project has a proposal template but we expect it to include both information about yourself, include a timeline with milestones, and address the following concerns.
Problem: Over the years of participating in Summers of Code, the RTEMS project has noticed some recurring themes with Summer of Code projects:
- Projects would not meet the needs of the RTEMS project (and so would not be upstreamed).
- Projects would be completed in such a way as they were not maintainable (external projects would make use of the RTEMS build system see:LUA, as opposed to using the external software's own build system see:rtems-addon-packages), or projects would be hardcoded based on the RTEMS tree at one point in time see:BuildingMingwTools? the NSIS installer.
- Projects would be partially done without enough information for the next Summer of Code (or Google Code-In) student to continue the work. For example: a change would be made for one architecture, but the way to generalize for the others was not documented.
- Projects would be submitted as one giant patch at the end of summer, if rtems-devel reviewed the patch, the student would be busy with schoolwork when it was time to make changes.
- Projects were not documented well enough for someone to verify it works.
- Projects would be done over and over again (instead of being new).
Solution: In the proposal the following MUST be included:
- A paragraph explaining what the project is trying to accomplish
- What is the core problem being solved?
- Why is this better than what we have already done?
- A sentence explaining how this project could be maintained (given developers have little time to maintain the code)
- Make documenting how the next summer of code student will pick up with developing the project in later years a project deliverable
- Break the project up into increments, so that if time runs out, each increment could be upstreamed, or at least written up on a wiki page so the next year's student could get farther faster.
- Make writing a tutorial to include a deliverable
- Email the first draft to rtems-devel@… for feedback, and make adjustments before submitting (THIS IS A CRITICAL REQUIREMENT!!!)
Expect the following questions from the email list:
- We really need something else specific done instead... could you do something else specific?
- What's the maintainence plan?
- How will we test it?
- We did this already... How is this an improvement?
- This is too much for you to complete in a summer... please remove these pieces from your proposal
In addition, the RTEMS project will furnish not only a mentor, but a co-mentor, and one or two additional people to help with keeping the project on a topic that is both meaningful for the student, and for RTEMS.
We really want your project to be the first step in your successful and long term participation in our project.
Visit Open Projects to find an interesting project, or propose your own! Ask about your project idea on the email list or IRC. The project descriptions often require additional knowledge to flesh out a project proposal.
We want you to hit the ground running, so you need to build RTEMS, modify it a little, and run samples as a prerequisite. Please visit the RTEMS GSoC Getting Started page for details.
RTEMS is an operating system targeting embedded systems that are cross-compiled, meaning that you develop on a host system and run programs on a target system. In general, students working on code require no special hardware, because RTEMS runs on simulators like gdb, skyeye, and qemu. The development can all be done and tested using a GNU/Linux or other suitable host.
Please read through the SoC Project Management page to get a sense of our expectations from you for the summer of code.
- Advice for Google Summer of Code Students from GSoC pageHow
- HOWTO: Write a Summer of Code application from Drupal.
- How Not to Apply to GSoC
Information for prior years:
- RTEMS Summer of Code 2016
- RTEMS Summer of Code 2015
- RTEMS Summer of Code 2014
- RTEMS Summer of Code 2013
- RTEMS Summer of Code 2012
- RTEMS Summer of Code 2011
- RTEMS Summer of Code 2010
- RTEMS Summer Of Code 2009
- RTEMS Summer Of Code 2008
Additionally, we have participated in multiple editions of the European Space Agency Summer of Code in Space:
Information for prior years:
- RTEMS SOCIS 2015