Difference between revisions of "GSoC"

From coreboot
Jump to: navigation, search
(moved past projects to Previous GSoC Projects)
(Remove flashrom from the project list for 2017)
 
(166 intermediate revisions by 16 users not shown)
Line 1: Line 1:
= Google Summer of Code 2009 =
+
coreboot is applying for [https://summerofcode.withgoogle.com/ Google Summer of Code 2017] as a mentoring organization.
 +
It is not assumed that we are accepted yet. We will announce this on the mailing list, chat.coreboot.org and update this page when we are informed on 27 February.
  
http://code.google.com/images/2009socwithlogo.gif
+
coreboot has many [[Project Ideas]] for various ability levels. The coreboot project also acts as an umbrella organization for other open-source firmware related projects.
  
Welcome to the [http://code.google.com/soc/ Google Summer of Code(tm)] page of the [[Welcome to coreboot|coreboot project]]. Apply for a coreboot GSoC project at http://socghop.appspot.com/.
+
Official student application period in 2017 is from March 20 to April 3, with results announced on April 4.  For the complete timeline, please see the [https://summerofcode.withgoogle.com/how-it-works/#timeline GSoC 2017 timeline].
  
= Your own Projects =
+
__FORCETOC__
  
We have come up with some ideas for cool Summer of Code projects here. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.
+
== coreboot contacts ==
  
But of course your application does not need to be based on any of the ideas listed below. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!
+
If you are interested in participating in GSoC as a student student, please visit [https://chat.coreboot.org/ chat.coreboot.org]. Working closely with the community is highly encouraged, as we've seen that our most successful students are generally very involved.
  
Feel free to contact us at the email address below, and don't hesitate to suggest whatever you have in mind.
+
[[User:PatrickGeorgi|Patrick Georgi]] and [[User:MartinRoth|Martin Roth]] are the coreboot GSoC admins for 2017.  Please feel free to reach out to them directly if you have any questions.
  
= Possible ideas =
+
= Why work on coreboot for GSoC 2017? =
  
== Infrastructure for automatic code checking ==
+
* coreboot offers you the opportunity to work with various architectures right on the iron. coreboot supports both current and older silicon for a wide variety of chips and technologies.
 +
* coreboot has a worldwide developer and user base.
 +
* We are a very passionate team, so you will interact directly with the project initiators and project leaders.
 +
* We have a large, helpful community. coreboot has some extremely talented and helpful experts in firmware involved in the project. They are ready to assist and mentor students participating in GSoC.
 +
* One of the last areas where open source software is not common is firmware. Running proprietary firmware can have severe effects on user's freedom and security. coreboot changes that by providing a common framework for initial hardware initialization and you can help us succeed.
  
We already have a build bot that builds various configurations of coreboot. It would be nice to extend it with various code validation routines, for example:
+
= GSoC Student requirements =
* Validate that there's no regression in doxygen documentation (eg. are all arguments to functions still explained in @param tags, eg. after new arguments were added?)
 
* Make code lint clean (and maybe extend lint to not fall into our traps), and run lint over the tree. Report regressions
 
* Use LLVM's static code checking facilities, report regressions.
 
* Work on code coverage support for coreboot code (dump data into ram, or via serial. Provide tools to fetch it). Analyse that data.
 
  
=== Links ===
+
What will be required of you to be a coreboot GSoC student?
* LLVM tools: [http://clang.llvm.org/StaticAnalysis.html Clang static analyser], [http://llvm.org/ProjectsWithLLVM/#Calysto SSA assertion checker]
 
* Lint tools: [http://lclint.cs.virginia.edu/ Splint]
 
* Coverage: [http://ltp.sourceforge.net/test/coverage/lcov.php LCOV], [http://ggcov.sourceforge.net GGCOV]
 
  
=== Mentors ===
+
Google Summer of Code is a full-time job. This means we expect you to work roughly 40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses, other obligations) does not give you this amount of time, then you should not apply. We expect to be able to see this level of effort in student output.
* [[User:PatrickGeorgi|Patrick Georgi]]
 
* [[User:MJones|Marc Jones]]
 
* [[User:Stepan|Stefan Reinauer]]
 
  
== TianoCore on coreboot ==
+
== Before applying ==
 +
*Prior to project acceptance, you have demonstrated that you can work with the coreboot codebase.
 +
:*By the time you have submitted your application, you should have downloaded, built and booted coreboot in QEMU, SimNow, or on real hardware. Please email your serial output results to the mailing list.
 +
:*Look over some of the development processes guidelines: [[git]], [https://review.coreboot.org/cgit/coreboot.git/plain/Documentation/gerrit_guidelines.md? Gerrit Etiquette and Guidelines], [[Development Guidelines]], and [[Developer Manual]]
 +
:*Get signed up for gerrit and push at least one patch to Gerrit for review. Check [[Easy projects]] or ask for simple tasks on the mailing list or on chat.coreboot.org if you need ideas.
 +
:*Look through some patches on gerrit to get an understanding of the review process and common issues
 +
*Before applying, you should also join the [https://www.coreboot.org/mailman/listinfo/coreboot mailing list] and [https://chat.coreboot.org chat.coreboot.org]. Introduce yourself and mention that you are a prospective GSoC student. Ask questions and discuss the project that you are considering. Community involvement is a key component of coreboot development.
  
[http://www.tianocore.org/ Tiano Core] is Intel's EFI implementation. Unlike coreboot, it is not a firmware, but rather a bootloader. Last year we started porting TianoCore to run on coreboot, but there are many things left to do. Improve Tiano Core running as a coreboot payloads, or change coreboot so it can load Tiano Core as a payloads.
+
== During the program ==
 +
* To pass and to be paid by Google requires that you meet certain milestones.
 +
:* First, you must be in good standing with the community before the official start of the program. We expect you to post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start.
 +
:* You must have made progress and committed significant code before the mid-term point and by the final.
 +
:* We require that accepted students to maintain a blog, where you are expected to write about your project *WEEKLY*. This is a way to measure progress and for the community at large to be able to help you. GSoC is *NOT* a private contract between your mentor and you. [https://blogs.coreboot.org/ blogs.coreboot.org]
 +
* Student must be active in the community on chat.coreboot.org and the mailing list.
 +
* Students are expected to work on development publicly, and to push commits to the project on a regular basis. Depending on the project and what your mentor agrees to, these can be published directly to the project or to a public repository such as gitlab or github. If you are not publishing directly to the project codebase, be aware that we do not want large dumps of code that need to be rushed to meet the mid-term and final goals.
  
This project requires no hardware skills, but especially in case of TianoCore might require knowledge of Windows compilers (VC2005?)
+
We don't expect our students to be experts in our problem domain, but we don't want you to fail because some basic misunderstanding was in your way of completing the task.
  
=== Links ===
+
= Projects =
* [http://www.tianocore.org/ Tiano Core]
 
  
=== Mentors ===
+
There are many development tasks available in coreboot. Please visit the following pages for some ideas or come up with your own idea.
* [[User:Rminnich|Ron Minnich]]
+
* [[Project Ideas|coreboot project ideas]]
* [[User:Stepan|Stefan Reinauer]]
+
<!-- * [https://www.flashrom.org/GSoC flashrom project ideas] -->
* [[User:MJones|Marc Jones]]
+
* [https://serialice.com/GSoC SerialICE project ideas]
  
= Previous Summer of Code projects =
+
We keep a list of [[previous GSoC Projects]] which might be of interest to you to see what others have accomplished.
 +
Similarly the [https://blogs.coreboot.org/blog/category/gsoc/ blog posts related to previous GSoC projects] might give some insights to what it is like to be a coreboot GSoC student.
  
We successfully participated in Google's Summer of Code in 2007 and 2008. See our [[Previous GSoC Projects|list of previous GSoC projects]].
+
== Your own Project Ideas ==
  
= Why work for coreboot =
+
We have come up with some ideas for cool Summer of Code projects. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.
  
Why would you like to work for coreboot?
+
Of course your application does not need to be based on any of the ideas listed. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!
  
* coreboot offers you the opportunity to work with modern technology "right on the iron".
+
= coreboot Summer of Code Application =
* Your application will be available to users worldwide and promoted along with all other coreboot projects.
 
* We are a very passionate team - so you will interact directly with the project initiators and project leaders.
 
* We have a large, helpful community. Over 100 experts in hardware and firmware lurk on our mailing list, many of them waiting to help you.
 
  
 +
coreboot welcomes students from all backgrounds and levels of experience.
  
= Summer of Code Application =
+
Your application should include a complete project proposal. You should document that you have the knowledge and the ability to complete your proposed project. This may require a little research and understanding of coreboot prior to sending your application. The community and coreboot project mentors are your best resource in fleshing out your project ideas and helping with a project timeline. We recommend that you get feedback and recommendations on your proposal before the application deadline.
  
Please complete the standard [http://code.google.com/soc/ Google SoC 2008 application]. Additionally, please provide information on the following:
+
Please complete the standard Google SoC application and project proposal. Prospective coreboot GSoC student should provide the following information as part of their application. If you are applying for a flashrom or SerialICE project use common sense when using the template below, this is part of the test. ;)
  
# Who are you? What are you studying?
+
=== Personal Information ===
# Why are you the right person for this task?
+
:Name:
# Do you have any other commitments that we should know about?
+
:Email:
# List your C, Assembler and hardware experience.
+
:Phone number:
# List your history with open source projects.
+
:chat/IM/IRC/Skype/other contact:
# What is your preferred method of contact? (Phone, email, Skype, etc)
+
:Country/Timezone:
 +
:Normal working hours(UTC):
 +
:School:
 +
:Degree Program:
 +
:Expected graduation date:
 +
:Short bio / overview of your background:
 +
:What are your other time commitments? Do you have a job, classes, vacations? When and how long?
  
Feel free to keep your application short. A 15 page essay is no better than a 2 page summary. If you wish to write 15 pages, you are of course welcome to do so, and we will gladly put your paper up on the web page. But it is not required for the application.
+
=== Software experience ===
 +
:Github / Web Page / Blog / Microblog / Portfolio:
 +
:Links to one or more patches submitted to the project you're applying for:
 +
:Links to posts on the mailing list with the serial output of your build: [https://www.coreboot.org/pipermail/coreboot/ Mailing List Archives]
 +
:Please comment on your software and firmware experience.
 +
:Have you contributed to an open source project? Which one? What was your experience?
 +
:Did you build and run coreboot? Did you have problems?
  
== How to apply ==
+
=== Your project ===
 +
: Please provide an overview of your project (in your own words).
 +
:: Provide break down of your project in small specific weekly goals. Think about the potential timeline.
 +
:: How will you accomplish this goal? What is your working style?
 +
:: Explain what risks or potential problems your project might experience.
 +
:: What would you expect as a minimum level of success?
 +
:: Do you have a stretch goal?
  
The Drupal project has a great page on [http://drupal.org/node/59037 How to write an SOC application].
+
=== Other ===
 +
:Resume (optional):
  
Please also read Google's [http://code.google.com/p/google-summer-of-code/wiki/AdviceforStudents Advice for Students].
+
== Advice on how to apply ==
 +
* The Drupal project has a great page on [https://www.drupal.org/node/59037 how to write an SOC application].
 +
* GSoC Student Guide: [http://en.flossmanuals.net/GSoCStudentGuide/]
 +
* Secrets for GSoC success: [http://softwareswirl.blogspot.com/2014/03/my-secret-tip-for-gsoc-success.html]
  
== Some Caveats ==
+
= Mentors =
  
* Google Summer-of-Code projects are a full (day-) time job. This means we expect roughly 30-40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses) does not give you this amount of spare time, then maybe you should not apply.
+
Each accepted project will have a lead mentor and a backup mentor. We will match mentors and students based on the project, experience level, and geographic location (native language, culture and time zone).
* Getting paid by Google requires that you meet certain milestones. First, you must be in good standing with the community before the official start of the program. We suggest you post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start. Also, you must have made progress and committed significant code before the mid-term point.
 
* We are thinking of requiring accepted students to have a blog, where you will write about your project on a regular basis. This is so that the community at large can be involved and help you. SoC is not a private contract between your mentor and you.  
 
  
== Time Frame ==
+
Summer of Code primary mentors, are expected to stay in frequent contact with the student and provide guidance such as code reviews, pointers to useful documentation, etc.  This should generally be a time commitment of one to two hours a week.
  
'''DEADLINE FOR STUDENT APPLICATIONS:''' Students who are interested in working on a coreboot-related GSoC project must apply between '''March 23, 2009''' and '''April 3, 2009'''! If you want to apply, please get in contact with us right away!
+
Backup mentors are expected to coordinate with the primary mentor and student on a regular basis, and keep track of the student process.  They should be work with the primary mentor and be available to take over mentoring duty if the primary mentor is unavailable (vacations, sickness, emergencies).
  
= Contact =
+
== Volunteering to be a mentor ==
  
If you are interested in becoming a GSoC student, please contact [mailto:stepan@coresystems.de Stefan Reinauer].
+
If you'd like to volunteer to be a mentor, please read the [https://developers.google.com/open-source/gsoc/resources/manual#mentor_manual GSoC Mentor Manual].  This will give you a better idea of expectations, and where to go for help.
 +
After that, contact Martin or Patrick and let them know that you're interested.
  
There is also an IRC channel on irc.freenode.net: #coreboot
+
The following coreboot developers have volunteered to be GSoC 2017 mentors. Please stop by [https://chat.coreboot.org chat.coreboot.org] and say hi to them and ask them questions.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Name !! Role !! Comms !! AFK / Vacation MMDD-MMDD
 +
|-
 +
| [[User:MartinRoth|Martin Roth]] || coreboot: co-organizer and mentor || chat: martinr Email: gaumless@gmail.com|| No dates yet
 +
|-
 +
| [[User:PatrickGeorgi|Patrick Georgi]] || coreboot: co-organizer and mentor || chat: patrickg, pgeorgi ||
 +
|-
 +
| [[User:Stepan|Stefan Reinauer]] || coreboot/serialice:  mentor  || chat: stepan ||
 +
|-
 +
| [[User:Rminnich|Ron Minnich]] || coreboot: mentor || chat: rminnich ||
 +
|-
 +
|}

Latest revision as of 10:05, 21 January 2017

coreboot is applying for Google Summer of Code 2017 as a mentoring organization. It is not assumed that we are accepted yet. We will announce this on the mailing list, chat.coreboot.org and update this page when we are informed on 27 February.

coreboot has many Project Ideas for various ability levels. The coreboot project also acts as an umbrella organization for other open-source firmware related projects.

Official student application period in 2017 is from March 20 to April 3, with results announced on April 4. For the complete timeline, please see the GSoC 2017 timeline.


coreboot contacts

If you are interested in participating in GSoC as a student student, please visit chat.coreboot.org. Working closely with the community is highly encouraged, as we've seen that our most successful students are generally very involved.

Patrick Georgi and Martin Roth are the coreboot GSoC admins for 2017. Please feel free to reach out to them directly if you have any questions.

Why work on coreboot for GSoC 2017?

  • coreboot offers you the opportunity to work with various architectures right on the iron. coreboot supports both current and older silicon for a wide variety of chips and technologies.
  • coreboot has a worldwide developer and user base.
  • We are a very passionate team, so you will interact directly with the project initiators and project leaders.
  • We have a large, helpful community. coreboot has some extremely talented and helpful experts in firmware involved in the project. They are ready to assist and mentor students participating in GSoC.
  • One of the last areas where open source software is not common is firmware. Running proprietary firmware can have severe effects on user's freedom and security. coreboot changes that by providing a common framework for initial hardware initialization and you can help us succeed.

GSoC Student requirements

What will be required of you to be a coreboot GSoC student?

Google Summer of Code is a full-time job. This means we expect you to work roughly 40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses, other obligations) does not give you this amount of time, then you should not apply. We expect to be able to see this level of effort in student output.

Before applying

  • Prior to project acceptance, you have demonstrated that you can work with the coreboot codebase.
  • By the time you have submitted your application, you should have downloaded, built and booted coreboot in QEMU, SimNow, or on real hardware. Please email your serial output results to the mailing list.
  • Look over some of the development processes guidelines: git, Gerrit Etiquette and Guidelines, Development Guidelines, and Developer Manual
  • Get signed up for gerrit and push at least one patch to Gerrit for review. Check Easy projects or ask for simple tasks on the mailing list or on chat.coreboot.org if you need ideas.
  • Look through some patches on gerrit to get an understanding of the review process and common issues
  • Before applying, you should also join the mailing list and chat.coreboot.org. Introduce yourself and mention that you are a prospective GSoC student. Ask questions and discuss the project that you are considering. Community involvement is a key component of coreboot development.

During the program

  • To pass and to be paid by Google requires that you meet certain milestones.
  • First, you must be in good standing with the community before the official start of the program. We expect you to post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start.
  • You must have made progress and committed significant code before the mid-term point and by the final.
  • We require that accepted students to maintain a blog, where you are expected to write about your project *WEEKLY*. This is a way to measure progress and for the community at large to be able to help you. GSoC is *NOT* a private contract between your mentor and you. blogs.coreboot.org
  • Student must be active in the community on chat.coreboot.org and the mailing list.
  • Students are expected to work on development publicly, and to push commits to the project on a regular basis. Depending on the project and what your mentor agrees to, these can be published directly to the project or to a public repository such as gitlab or github. If you are not publishing directly to the project codebase, be aware that we do not want large dumps of code that need to be rushed to meet the mid-term and final goals.

We don't expect our students to be experts in our problem domain, but we don't want you to fail because some basic misunderstanding was in your way of completing the task.

Projects

There are many development tasks available in coreboot. Please visit the following pages for some ideas or come up with your own idea.

We keep a list of previous GSoC Projects which might be of interest to you to see what others have accomplished. Similarly the blog posts related to previous GSoC projects might give some insights to what it is like to be a coreboot GSoC student.

Your own Project Ideas

We have come up with some ideas for cool Summer of Code projects. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.

Of course your application does not need to be based on any of the ideas listed. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!

coreboot Summer of Code Application

coreboot welcomes students from all backgrounds and levels of experience.

Your application should include a complete project proposal. You should document that you have the knowledge and the ability to complete your proposed project. This may require a little research and understanding of coreboot prior to sending your application. The community and coreboot project mentors are your best resource in fleshing out your project ideas and helping with a project timeline. We recommend that you get feedback and recommendations on your proposal before the application deadline.

Please complete the standard Google SoC application and project proposal. Prospective coreboot GSoC student should provide the following information as part of their application. If you are applying for a flashrom or SerialICE project use common sense when using the template below, this is part of the test. ;)

Personal Information

Name:
Email:
Phone number:
chat/IM/IRC/Skype/other contact:
Country/Timezone:
Normal working hours(UTC):
School:
Degree Program:
Expected graduation date:
Short bio / overview of your background:
What are your other time commitments? Do you have a job, classes, vacations? When and how long?

Software experience

Github / Web Page / Blog / Microblog / Portfolio:
Links to one or more patches submitted to the project you're applying for:
Links to posts on the mailing list with the serial output of your build: Mailing List Archives
Please comment on your software and firmware experience.
Have you contributed to an open source project? Which one? What was your experience?
Did you build and run coreboot? Did you have problems?

Your project

Please provide an overview of your project (in your own words).
Provide break down of your project in small specific weekly goals. Think about the potential timeline.
How will you accomplish this goal? What is your working style?
Explain what risks or potential problems your project might experience.
What would you expect as a minimum level of success?
Do you have a stretch goal?

Other

Resume (optional):

Advice on how to apply

Mentors

Each accepted project will have a lead mentor and a backup mentor. We will match mentors and students based on the project, experience level, and geographic location (native language, culture and time zone).

Summer of Code primary mentors, are expected to stay in frequent contact with the student and provide guidance such as code reviews, pointers to useful documentation, etc. This should generally be a time commitment of one to two hours a week.

Backup mentors are expected to coordinate with the primary mentor and student on a regular basis, and keep track of the student process. They should be work with the primary mentor and be available to take over mentoring duty if the primary mentor is unavailable (vacations, sickness, emergencies).

Volunteering to be a mentor

If you'd like to volunteer to be a mentor, please read the GSoC Mentor Manual. This will give you a better idea of expectations, and where to go for help. After that, contact Martin or Patrick and let them know that you're interested.

The following coreboot developers have volunteered to be GSoC 2017 mentors. Please stop by chat.coreboot.org and say hi to them and ask them questions.

Name Role Comms AFK / Vacation MMDD-MMDD
Martin Roth coreboot: co-organizer and mentor chat: martinr Email: gaumless@gmail.com No dates yet
Patrick Georgi coreboot: co-organizer and mentor chat: patrickg, pgeorgi
Stefan Reinauer coreboot/serialice: mentor chat: stepan
Ron Minnich coreboot: mentor chat: rminnich