Write Code. Save Lives.
OpenMRS plans to apply as a mentoring organization for Google Summer of Code™ in 2017. Since 2007, we've enjoyed participating in this great program and we're extremely excited about the projects and mentorship opportunities available this year. Coding for OpenMRS is a great way to practice your coding skills and, at the same time, help benefit people in developing countries who are on the front lines of the battle against HIV/AIDS, TB, Malaria, and other public health challenges. For a more detailed history of who were are and what we do, please see here.
Expectations for Students
Before being accepted
- Become familiar with OpenMRS and the project(s) for which you're applying. If relevant, make sure you have OpenMRS installed and running. (You should have done this already since you were accepted.) Read Developer Guide, Getting Started as a Developer, and ask others in the community if you have questions. If you ask questions the smart way, you'll get better responses.
- Make sure your development environment is installed and running, and optimized for maximum efficiency. Review our Conventions page.
- Review project ideas listed here & ask questions about those or other projects in the GSoC category on OpenMRS Talk.
- Spend as much time as possible in our IRC channel or Telegram chat, as well as on OpenMRS Talk with other community members. Remember, GSoC-specific questions should be asked on Talk.
- Introduce yourself on the community introduction page on OpenMRS Talk.
- If you're returning to do GSoC with OpenMRS for a repeat term, be just as thorough (or more so!) than first-time students. Don't skip steps and work extra hard to impress your mentor(s).
After being accepted
- Set up a blog for your work on open source projects, including GSoC. Post the URL on OpenMRS Talk. If you don't have a blog yet, you should create one. You will be required to write a blog post every week about your planning work and project progress during GSoC.
- Contact your mentor immediately. Make a plan to communicate with them regularly. You should plan to use some combination of IRC or Telegram chat, or discussions on OpenMRS Talk (in a specific category or with a unique tag). Open source projects communicate in the open, so plan to keep any direct/private communication to an absolute minimum.
- Begin attending the weekly Developers Forum to briefly introduce yourself and meet other interns & contributors. Attend as many Developers Forums as your schedule permits.
- Review any JIRA issues related to your project and work on some initial bugs or feature development, or work on some general OpenMRS bugs. Ask your mentor for guidance. (This doesn't mean begin your project!)
- Prepare a detailed project plan together with your mentor. Browse the current OpenMRS code specific to your project and review the requirements for your project together with your mentor. Include SMART goals and schedule milestones for each week. Publish the project plan on OpenMRS Talk in the appropriate category. (Request a new subcategory if needed.)
During the program
- Complete a short required "progress report" each week so we can make sure things are on track and there are no problems with your project. Contact organization admins any time if you have concerns about working with your mentor(s).
- Write at least one blog post every week to help stay on schedule and to share your work publicly.
- Commit early. Commit often. This is an important value in our open source community - read why.
- Prepare mid-term & final project presentation videos about your project's status, progress, and any questions you have for the community.
- You are now part of our developer community. We want you to feel like part of the team, so we expect you to:
After completing GSoC
- Write a final blog post summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog.
- Stay involved with your project or other projects as your schedule permits! There is always plenty of development work needed for OpenMRS volunteers like you.
- Continue to watch OpenMRS Talk for additional questions or feedback about your GSoC project, and for other topics that interest you.
- Participate as a mentor for Google Code-in, in late 2016, should OpenMRS be accepted to participate. Your involvement will show secondary school students how they can use their skills in programming and open source projects.
Expectations for Mentors
Before student selection
- Commit to spending a minimum of 4 hours each week to be available to guide and mentor students (not just your assigned student).
- Commit to being present in IRC and/or Telegram to help answer questions as much as your schedule allows, at a minimum of 4 hours each week.
- Prepare a good overview of your project idea(s) and have them linked to this wiki page.
- Watch OpenMRS Talk for questions about your project idea(s).
- Review student proposals and work with other mentors and organization admins to select the best candidates for OpenMRS.
- Treat returning students who have applied with as much (or more!) scrutiny than first-time students.
After student selection
- Ensure your student is ready & active. They should have a dev environment, be regularly communicating in the community, and have prepared a project plan together with you. (See above for student expectations.)
- Read the GSoC Mentoring Manual and ask questions if you have them.
- Reach out to the Summer of Code organization administrators if you have questions or concerns.
- If the student is not active during the community bonding period, please contact the organization administrators.
During the program
- Help your student be successful. Commit to spending a minimum of 4 hours each week answering questions, giving advice, working with your student on blockers, and evaluating your student's progress.
- Complete a short "progress report" each week to help stay on schedule and catch potential problems early.
- Have fun and work hard! The highest-performing mentors will get an expenses-paid trip to Google's headquarters in October to geek out with fellow mentors from other open source projects.
- Schedule some time to chat 1-on-1 with your student to talk about their post-GSoC plans. Will they continue in their university program? Are they looking for a job? Help them understand the world beyond GSoC, and how they can continue contributing to OpenMRS.
After completing GSoC
- Stay in touch with your student and help them find interesting ways to stay involved with OpenMRS.
- Apply to attend the GSoC mentor summit in October! It's an awesome way to connect with other people in the open source world and have fun.
Our Technology At-A-Glance
The OpenMRS project is architecture is quite extensive, and incorporates a number of different components, programming languages and frameworks. As an GSoC student, you may be required to work on one or many of these components. Each project is different – consult the mentor and project documentation for details. The OpenMRS Developers Guide covers some of our software's technical architecture in more detail.
Some of the core skills you might be able to use in our projects this year include:
- The Spring Framework
- The Hibernate Framework
- More to come ....
Application Requirements & Questions
You should have communicated in advance with the potential mentors listed above to prepare one or more project proposals. This proposal must describe in detail how you would plan to approach the project, and must include goals and a draft timeline. In addition to the project proposal, you needed to respond to the following questions:
- Who are you? What are you studying?
- Why are you the right person for this task?
- Describe in detail your software development experience by various technologies. Include all technologies you have used for development projects.
- List any previous experience working with open source projects other than OpenMRS. (This experience is not a requirement.)
- Provide links to any websites or applications created by you, or other source code examples.
- Please provide the URL to your wiki personal space and OpenMRS Talk profile page. (If you don't have them yet, please create & customize!)
- You must have made at least one coding contribution to OpenMRS BEFORE submitting your proposal. Please include in your proposal all relevant issue numbers, pull requests, commit links, etc. for these contributions. If you don't include this information, your proposal will not be reviewed. It's not necessary for your pull requests need to be merged. We just want to see that you've made some effort to learn the basics about OpenMRS.
- Describe your interactions with our community so far. Include dates of developer forums you have attended, and include any IRC nicknames used when visiting our channel previously.
- What is your preferred method of contact and how should we reach you with it? (phone, email, IRC, IM, etc.)
- Do you have any other commitments during the program? (Include any and all holidays, vacations, travel, exams, classes, research projects, other work, job offers, etc.)
When preparing your application, also remember to:
- Use the title of the project idea for which you are applying as the title of your application. If you are submitting an application to work on the "Add whirlygigs to OpenMRS" project, then make the title of your application "Add whirlygigs to OpenMRS".
- Submit a thoughtful application. Simply regurgitating documentation from the wiki will not impress us. Rather, show that you've thought about the project and provide some ideas on how you would approach the solution. You can ask other people in the community for ideas in advance. The best applications not only refer to one of the GSoC projects, but also demonstrate you have thought about the project by providing a description of how you think you might approach the project, including a rough timeline of the steps involved.
Have Additional Questions?
- If you are interested in Summer of Code this year and have further questions that aren't answered here, please post them in our GSoC category at OpenMRS Talk.